Skip to content

Commit 4f03efb

Browse files
committed
Add to docs
1 parent c54f429 commit 4f03efb

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/api.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,30 @@ The accessor style (`da.plotly.line()`) works but doesn't provide IDE code compl
4242
- box
4343
- imshow
4444

45+
## Configuration
46+
47+
Customize label extraction and slot assignment behavior:
48+
49+
```python
50+
import xarray_plotly as xp
51+
52+
# View current options
53+
xp.config.get_options()
54+
55+
# Set options (works as context manager)
56+
with xp.config.set_options(label_include_units=False):
57+
fig = xpx(da).line()
58+
```
59+
60+
::: xarray_plotly.config
61+
options:
62+
show_root_heading: true
63+
members:
64+
- get_options
65+
- set_options
66+
- Options
67+
- DEFAULT_SLOT_ORDERS
68+
4569
## Common Utilities
4670

4771
::: xarray_plotly.common

0 commit comments

Comments
 (0)