registering
Register plotly-resampler to (un)wrap plotly-graph-objects.
register_plotly_resampler(mode='auto', **aggregator_kwargs)
¶
Register plotly-resampler to plotly.graph_objects.
This function results in the use of plotly-resampler under the hood.
Note
We advise to use mode= widget
when working in an IPython based environment
as this will just behave as a go.FigureWidget
, but with dynamic aggregation.
When using mode= auto
or figure
; most figures will be wrapped as
FigureResampler
,
on which
show_dash
needs to be called.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
mode |
str
|
The mode of the plotly-resampler. Possible values are: ‘auto’, ‘figure’, ‘widget’, None. If ‘auto’ is used, the mode is determined based on the environment; if it is in an IPython environment, the mode is ‘widget’, otherwise it is ‘figure’. If ‘figure’ is used, all plotly figures are wrapped as FigureResampler objects. If ‘widget’ is used, all plotly figure widgets are wrapped as FigureWidgetResampler objects (we advise to use this mode in IPython environment with a kernel). If None is used, wrapping is done as expected (go.Figure -> FigureResampler, go.FigureWidget -> FigureWidgetResampler). |
'auto'
|
aggregator_kwargs |
dict
|
The keyword arguments to pass to the plotly-resampler decorator its constructor.
See more details in |
{}
|
Source code in plotly_resampler/registering.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
|
unregister_plotly_resampler()
¶
Unregister plotly-resampler from plotly.graph_objects.
Source code in plotly_resampler/registering.py
136 137 138 139 140 |
|