/
plotly.py
394 lines (323 loc) · 13.9 KB
/
plotly.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
"""
Defines a PlotlyPane which renders a plotly plot using PlotlyPlot
bokeh model.
"""
from __future__ import annotations
from typing import (
TYPE_CHECKING, Any, ClassVar, List, Mapping, Optional,
)
import numpy as np
import param
from bokeh.models import ColumnDataSource
from pyviz_comms import JupyterComm
from ..io.resources import CDN_DIST
from ..util import isdatetime, lazy_load
from ..viewable import Layoutable
from .base import ModelPane
if TYPE_CHECKING:
from bokeh.document import Document
from bokeh.model import Model
from pyviz_comms import Comm
class Plotly(ModelPane):
"""
The `Plotly` pane renders Plotly plots inside a panel.
Note that
- the Panel `extension` has to be loaded with `plotly` as an argument to
ensure that Plotly.js is initialized.
- it supports click, hover and selection events.
- it optimizes the plot rendering by using binary serialization for any
array data found on the Plotly object.
Reference: https://panel.holoviz.org/reference/panes/Plotly.html
:Example:
>>> pn.extension('plotly')
>>> Plotly(some_plotly_figure, width=500, height=500)
"""
click_data = param.Dict(doc="Click callback data")
clickannotation_data = param.Dict(doc="Clickannotation callback data")
config = param.Dict(doc="Config data")
hover_data = param.Dict(doc="Hover callback data")
link_figure = param.Boolean(default=True, doc="""
Attach callbacks to the Plotly figure to update output when it
is modified in place.""")
relayout_data = param.Dict(doc="Relayout callback data")
restyle_data = param.List(doc="Restyle callback data")
selected_data = param.Dict(doc="Selected callback data")
viewport = param.Dict(doc="Current viewport state")
viewport_update_policy = param.Selector(default="mouseup", doc="""
Policy by which the viewport parameter is updated during user interactions.
* "mouseup": updates are synchronized when mouse button is
released after panning
* "continuous": updates are synchronized continually while panning
* "throttle": updates are synchronized while panning, at
intervals determined by the viewport_update_throttle parameter
""", objects=["mouseup", "continuous", "throttle"])
viewport_update_throttle = param.Integer(default=200, bounds=(0, None), doc="""
Time interval in milliseconds at which viewport updates are
synchronized when viewport_update_policy is "throttle".""")
_render_count = param.Integer(default=0, doc="""
Number of renders, increment to trigger re-render""")
priority: ClassVar[float | bool | None] = 0.8
_stylesheets: ClassVar[List[str]] = [
f'{CDN_DIST}css/plotly.css'
]
_updates: ClassVar[bool] = True
_rename: ClassVar[Mapping[str, str | None]] = {
'link_figure': None, 'object': None
}
@classmethod
def applies(cls, obj: Any) -> float | bool | None:
return ((isinstance(obj, list) and obj and all(cls.applies(o) for o in obj)) or
hasattr(obj, 'to_plotly_json') or (isinstance(obj, dict)
and 'data' in obj and 'layout' in obj))
def __init__(self, object=None, **params):
super().__init__(object, **params)
self._figure = None
self._event = None
self._update_figure()
def _to_figure(self, obj):
import plotly.graph_objs as go
if isinstance(obj, go.Figure):
return obj
elif isinstance(obj, dict):
data, layout = obj['data'], obj['layout']
elif isinstance(obj, tuple):
data, layout = obj
else:
data, layout = obj, {}
data = data if isinstance(data, list) else [data]
return go.Figure(data=data, layout=layout)
@staticmethod
def _get_sources(json):
sources = []
traces = json.get('data', [])
for trace in traces:
data = {}
Plotly._get_sources_for_trace(trace, data)
sources.append(ColumnDataSource(data))
return sources
@staticmethod
def _get_sources_for_trace(json, data, parent_path=''):
for key, value in list(json.items()):
full_path = key if not parent_path else "{}.{}".format(parent_path, key)
if isinstance(value, np.ndarray):
# Extract numpy array
data[full_path] = [json.pop(key)]
elif isinstance(value, dict):
# Recurse into dictionaries:
Plotly._get_sources_for_trace(value, data=data, parent_path=full_path)
elif isinstance(value, list) and value and isinstance(value[0], dict):
# recurse into object arrays:
for i, element in enumerate(value):
element_path = full_path + '.' + str(i)
Plotly._get_sources_for_trace(
element, data=data, parent_path=element_path
)
@param.depends('object', 'link_figure', watch=True)
def _update_figure(self):
import plotly.graph_objs as go
if (self.object is None or type(self.object) is not go.Figure or
self.object is self._figure or not self.link_figure):
return
# Monkey patch the message stubs used by FigureWidget.
# We only patch `Figure` objects (not subclasses like FigureWidget) so
# we don't interfere with subclasses that override these methods.
fig = self.object
fig._send_addTraces_msg = lambda *_, **__: self._update_from_figure('add')
fig._send_moveTraces_msg = lambda *_, **__: self._update_from_figure('move')
fig._send_deleteTraces_msg = lambda *_, **__: self._update_from_figure('delete')
fig._send_restyle_msg = self._send_restyle_msg
fig._send_relayout_msg = self._send_relayout_msg
fig._send_update_msg = self._send_update_msg
fig._send_animate_msg = lambda *_, **__: self._update_from_figure('animate')
self._figure = fig
def _send_relayout_msg(self, relayout_data, source_view_id=None):
self._send_update_msg({}, relayout_data, None, source_view_id)
def _send_restyle_msg(self, restyle_data, trace_indexes=None, source_view_id=None):
self._send_update_msg(restyle_data, {}, trace_indexes, source_view_id)
@param.depends('restyle_data', watch=True)
def _update_figure_style(self):
if self._figure is None or self.restyle_data is None:
return
self._figure.plotly_restyle(*self.restyle_data)
@param.depends('relayout_data', watch=True)
def _update_figure_layout(self):
if self._figure is None or self.relayout_data is None:
return
relayout_data = self._clean_relayout_data(self.relayout_data)
# The _compound_array_props are sometimes not correctly reset
# which means that they are desynchronized with _props causing
# incorrect lookups and potential errors when updating a property
self._figure.layout._compound_array_props.clear()
self._figure.plotly_relayout(relayout_data)
@staticmethod
def _clean_relayout_data(relayout_data):
return {
key: val for key, val in relayout_data.items() if not key.endswith("._derived")
}
def _send_update_msg(
self, restyle_data, relayout_data, trace_indexes=None, source_view_id=None
):
if source_view_id:
return
trace_indexes = self._figure._normalize_trace_indexes(trace_indexes)
msg = {}
if relayout_data:
msg['relayout'] = relayout_data
if restyle_data:
msg['restyle'] = {'data': restyle_data, 'traces': trace_indexes}
for ref, (m, _) in self._models.items():
self._apply_update([], msg, m, ref)
def _update_from_figure(self, event, *args, **kwargs):
self._event = event
try:
self.param.trigger('object')
finally:
self._event = None
def _update_data_sources(self, cds, trace):
trace_arrays = {}
Plotly._get_sources_for_trace(trace, trace_arrays)
update_sources = False
for key, new_col in trace_arrays.items():
new = new_col[0]
try:
old = cds.data.get(key)[0]
update_array = (
(type(old) != type(new)) or
(new.shape != old.shape) or
(new != old).any())
except Exception:
update_array = True
if update_array:
update_sources = True
cds.data[key] = [new]
return update_sources
@staticmethod
def _plotly_json_wrapper(fig):
"""Wraps around to_plotly_json and applies necessary fixes.
For #382: Map datetime elements to strings.
"""
json = fig.to_plotly_json()
data = json['data']
for idx in range(len(data)):
for key in data[idx]:
if isdatetime(data[idx][key]):
arr = data[idx][key]
if isinstance(arr, np.ndarray):
arr = arr.astype(str)
else:
arr = [str(v) for v in arr]
data[idx][key] = arr
return json
def _init_params(self):
viewport_params = [p for p in self.param if 'viewport' in p]
parameters = list(Layoutable.param)+viewport_params
params = {p: getattr(self, p) for p in parameters
if getattr(self, p) is not None}
if self.object is None:
json, sources = {}, []
else:
fig = self._to_figure(self.object)
json = self._plotly_json_wrapper(fig)
sources = Plotly._get_sources(json)
params['_render_count'] = self._render_count
params['config'] = self.config or {}
params['data'] = json.get('data', [])
params['data_sources'] = sources
params['layout'] = layout = json.get('layout', {})
params['frames'] = json.get('frames', [])
if layout.get('autosize') and self.sizing_mode is self.param.sizing_mode.default:
params['sizing_mode'] = 'stretch_both'
if 'styles' not in params:
params['styles'] = {}
return params
def _process_param_change(self, params):
props = super()._process_param_change(params)
if 'layout' in props or 'stylesheets' in props:
if 'layout' in props:
layout = props['layout']
elif self._models:
# Improve lookup of current layout
layout = list(self._models.values())[0][0].layout
else:
return props
btn_color = layout.get('template', {}).get('layout', {}).get('font', {}).get('color', 'black')
props['stylesheets'] = props.get('stylesheets', []) + [
f':host {{ --plotly-icon-color: gray; --plotly-active-icon-color: {btn_color}; }}'
]
return props
def _get_model(
self, doc: Document, root: Optional[Model] = None,
parent: Optional[Model] = None, comm: Optional[Comm] = None
) -> Model:
self._bokeh_model = lazy_load(
'panel.models.plotly', 'PlotlyPlot', isinstance(comm, JupyterComm), root
)
return super()._get_model(doc, root, parent, comm)
def _update(self, ref: str, model: Model) -> None:
if self.object is None:
model.update(data=[], layout={})
model._render_count += 1
return
fig = self._to_figure(self.object)
json = self._plotly_json_wrapper(fig)
layout = json.get('layout')
frames = json.get('frames')
traces = json['data']
new_sources = []
update_sources = False
for i, trace in enumerate(traces):
if i < len(model.data_sources):
cds = model.data_sources[i]
else:
cds = ColumnDataSource()
new_sources.append(cds)
update_sources = self._update_data_sources(cds, trace) or update_sources
# Determine if layout needs update
try:
update_layout = model.layout != layout
except Exception:
update_layout = True
# Determine if model needs updates
if (len(model.data) != len(traces)):
update_data = True
else:
update_data = False
for new, old in zip(traces, model.data):
try:
update_data = (
{k: v for k, v in new.items() if k != 'uid'} !=
{k: v for k, v in old.items() if k != 'uid'}
)
except Exception:
update_data = True
if update_data:
break
# Determine if frames needs update
try:
update_frames = model.frames != frames
except Exception:
update_frames = True
updates = {}
if self.sizing_mode is self.param.sizing_mode.default and 'autosize' in layout:
autosize = layout.get('autosize')
styles = dict(model.styles)
if autosize and model.sizing_mode != 'stretch_both':
updates['sizing_mode'] = 'stretch_both'
styles['display'] = 'contents'
elif not autosize and model.sizing_mode != 'fixed':
updates['sizing_mode'] = 'fixed'
if 'display' in styles:
del styles['display']
if new_sources:
updates['data_sources'] = model.data_sources + new_sources
if update_data:
updates['data'] = json.get('data')
if update_layout:
updates['layout'] = layout
if update_frames:
updates['frames'] = frames or []
if updates:
model.update(**updates)
# Check if we should trigger rendering
if updates or update_sources:
model._render_count += 1