forked from plotly/plotly.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgraph_widget.py
More file actions
608 lines (486 loc) · 20.9 KB
/
graph_widget.py
File metadata and controls
608 lines (486 loc) · 20.9 KB
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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
from collections import deque
import json
import os
import uuid
# TODO: protected imports?
from IPython.html import widgets
from IPython.utils.traitlets import Unicode
from IPython.display import Javascript, display
from plotly import utils
# Load JS widget code
# No officially recommended way to do this in any other way
# http://mail.scipy.org/pipermail/ipython-dev/2014-April/013835.html
directory = os.path.dirname(os.path.realpath(__file__))
js_widget_file = os.path.join(directory, 'graphWidget.js')
with open(js_widget_file) as f:
js_widget_code = f.read()
display(Javascript(js_widget_code))
__all__ = None
class GraphWidget(widgets.DOMWidget):
"""An interactive Plotly graph widget for use in IPython
Notebooks.
"""
_view_name = Unicode('GraphView', sync=True)
_message = Unicode(sync=True)
_graph_url = Unicode(sync=True)
# TODO: URL for offline enterprise
def __init__(self, graph_url='https://plot.ly/~playground/7', **kwargs):
"""Initialize a plotly graph widget
Args:
graph_url: The url of a Plotly graph
Example:
```
GraphWidget('https://plot.ly/~chris/3375')
```
"""
super(GraphWidget, self).__init__(**kwargs)
# TODO: Validate graph_url
self._graph_url = graph_url
self._listener_set = set()
self._event_handlers = {
'click': widgets.CallbackDispatcher(),
'hover': widgets.CallbackDispatcher(),
'zoom': widgets.CallbackDispatcher()
}
self._graphId = ''
self.on_msg(self._handle_msg)
# messages to the iframe client need to wait for the
# iframe to communicate that it is ready
# unfortunately, this two-way blocking communication
# isn't possible
# (https://github.com/ipython/ipython/wiki/IPEP-21:-Widget-Messages#caveats)
# so we'll just cue up messages until they're ready to be sent
self._clientMessages = deque()
def _handle_msg(self, message):
"""Handle a msg from the front-end.
Args:
content (dict): Content of the msg.
"""
content = message['content']['data']['content']
if content.get('event', '') == 'pong':
self._graphId = content['graphId']
# ready to recieve - pop out all of the items in the deque
while self._clientMessages:
_message = self._clientMessages.popleft()
_message['graphId'] = self._graphId
_message = json.dumps(_message)
self._message = _message
if content.get('event', '') in ['click', 'hover', 'zoom']:
# De-nest the message
if content['event'] == 'click' or content['event'] == 'hover':
message = content['message']['points']
elif content['event'] == 'zoom':
message = content['message']['ranges']
self._event_handlers[content['event']](self, message)
def _handle_registration(self, event_type, callback, remove):
self._event_handlers[event_type].register_callback(callback,
remove=remove)
event_callbacks = self._event_handlers[event_type].callbacks
if (len(event_callbacks) and event_type not in self._listener_set):
self._listener_set.add(event_type)
message = {'task': 'listen', 'events': list(self._listener_set)}
self._handle_outgoing_message(message)
def _handle_outgoing_message(self, message):
if self._graphId == '':
self._clientMessages.append(message)
else:
message['graphId'] = self._graphId
message['uid'] = str(uuid.uuid4())
self._message = json.dumps(message, cls=utils.PlotlyJSONEncoder)
def on_click(self, callback, remove=False):
""" Assign a callback to click events propagated
by clicking on point(s) in the Plotly graph.
Args:
callback (function): Callback function this is called
on click events with the signature:
callback(widget, hover_obj) -> None
Args:
widget (GraphWidget): The current instance
of the graph widget that this callback is assigned to.
click_obj (dict): a nested dict that describes
which point(s) were clicked on.
click_obj example:
[
{
'curveNumber': 1,
'pointNumber': 2,
'x': 4,
'y': 14
}
]
remove (bool, optional): If False, attach the callback.
If True, remove the callback. Defaults to False.
Returns:
None
Example:
```
from IPython.display import display
def message_handler(widget, msg):
display(widget._graph_url)
display(msg)
g = GraphWidget('https://plot.ly/~chris/3375')
display(g)
g.on_click(message_handler)
```
"""
self._handle_registration('click', callback, remove)
def on_hover(self, callback, remove=False):
""" Assign a callback to hover events propagated
by hovering over points in the Plotly graph.
Args:
callback (function): Callback function this is called
on hover events with the signature:
callback(widget, hover_obj) -> None
Args:
widget (GraphWidget): The current instance
of the graph widget that this callback is assigned to.
hover_obj (dict): a nested dict that describes
which point(s) was hovered over.
hover_obj example:
[
{
'curveNumber': 1,
'pointNumber': 2,
'x': 4,
'y': 14
}
]
remove (bool, optional): If False, attach the callback.
If True, remove the callback. Defaults to False.
Returns:
None
Example:
```
from IPython.display import display
def message_handler(widget, hover_msg):
display(widget._graph_url)
display(hover_msg)
g = GraphWidget('https://plot.ly/~chris/3375')
display(g)
g.on_hover(message_handler)
```
"""
self._handle_registration('hover', callback, remove)
def on_zoom(self, callback, remove=False):
""" Assign a callback to zoom events propagated
by zooming in regions in the Plotly graph.
Args:
callback (function): Callback function this is called
on zoom events with the signature:
callback(widget, ranges) -> None
Args:
widget (GraphWidget): The current instance
of the graph widget that this callback is assigned to.
ranges (dict): A description of the
region that was zoomed into.
ranges example:
{
'x': [1.8399058038561549, 2.16443359662],
'y': [4.640902872777017, 7.855677154582]
}
remove (bool, optional): If False, attach the callback.
If True, remove the callback. Defaults to False.
Returns:
None
Example:
```
from IPython.display import display
def message_handler(widget, ranges):
display(widget._graph_url)
display(ranges)
g = GraphWidget('https://plot.ly/~chris/3375')
display(g)
g.on_zoom(message_handler)
```
"""
self._handle_registration('zoom', callback, remove)
def restyle(self, data, indices=None):
"""Update the style of existing traces in the Plotly graph.
Args:
update (dict):
dict where keys are the graph attribute strings
and values are the value of the graph attribute.
To update graph objects that are nested, like
a marker's color, combine the keys with a period,
e.g. `marker.color`. To replace an entire nested object,
like `marker`, set the value to the object.
See Example 2 below.
To update an attribute of multiple traces, set the
value to an list of values. If the list is shorter
than the number of traces, the values will wrap around.
Note: this means that for values that are naturally an array,
like `x` or `colorscale`, you need to wrap the value
in an extra array,
i.e. {'colorscale': [[[0, 'red'], [1, 'green']]]}
You can also supply values to different traces with the
indices argument.
See all of the graph attributes in our reference documentation
here: https://plot.ly/python/reference or by calling `help` on
graph objects in `plotly.graph_objs`.
indices (list, optional):
Specify which traces to apply the update dict to.
Negative indices are supported.
If indices are not given, the update will apply to
*all* traces.
Examples:
Initialization - Start each example below with this setup:
```
from plotly.widgets import Graph
from IPython.display import display
graph = GraphWidget('https://plot.ly/~chris/3979')
display(graph)
```
Example 1 - Set `marker.color` to red in every trace in the graph
```
graph.restyle({'marker.color': 'red'})
```
Example 2 - Replace `marker` with {'color': 'red'}
```
graph.restyle({'marker': {'color': red'}})
```
Example 3 - Set `marker.color` to red
in the first trace of the graph
```
graph.restyle({'marker.color': 'red'}, indices=[0])
```
Example 4 - Set `marker.color` of all of the traces to
alternating sequences of red and green
```
graph.restyle({'marker.color': ['red', 'green']})
```
Example 5 - Set just `marker.color` of the first two traces
to red and green
```
graph.restyle({'marker.color': ['red', 'green']}, indices=[0, 1])
```
Example 6 - Set multiple attributes of all of the traces
```
graph.restyle({
'marker.color': 'red',
'line.color': 'green'
})
```
Example 7 - Update the data of the first trace
```
graph.restyle({
'x': [[1, 2, 3]],
'y': [[10, 20, 30]],
}, indices=[0])
```
Example 8 - Update the data of the first two traces
```
graph.restyle({
'x': [[1, 2, 3],
[1, 2, 4]],
'y': [[10, 20, 30],
[5, 8, 14]],
}, indices=[0, 1])
```
"""
# TODO: Add flat traces to graph_objs
message = {'task': 'restyle', 'update': data, 'graphId': self._graphId}
if indices:
message['indices'] = indices
self._handle_outgoing_message(message)
def relayout(self, layout):
"""Update the layout of the Plotly graph.
Args:
layout (dict):
dict where keys are the graph attribute strings
and values are the value of the graph attribute.
To update graph objects that are nested, like
the title of an axis, combine the keys with a period
e.g. `xaxis.title`. To set a value of an element in an array,
like an axis's range, use brackets, e.g. 'xaxis.range[0]'.
To replace an entire nested object, just specify the value to
the sub-object. See example 4 below.
See all of the layout attributes in our reference documentation
https://plot.ly/python/reference/#Layout
Or by calling `help` on `plotly.graph_objs.Layout`
Examples - Start each example below with this setup:
Initialization:
```
from plotly.widgets import Graph
from IPython.display import display
graph = GraphWidget('https://plot.ly/~chris/3979')
display(graph)
```
Example 1 - Update the title
```
graph.relayout({'title': 'Experimental results'})
```
Example 2 - Update the xaxis range
```
graph.relayout({'xaxis.range': [-1, 6]})
```
Example 3 - Update the first element of the xaxis range
```
graph.relayout({'xaxis.range[0]': -3})
```
Example 4 - Replace the entire xaxis object
```
graph.relayout({'xaxis': {'title': 'Experimental results'}})
```
"""
# TODO: Add flat layout to graph_objs
message = {
'task': 'relayout', 'update': layout, 'graphId': self._graphId
}
self._handle_outgoing_message(message)
def hover(self, *hover_objs):
"""Show hover labels over the points specified in hover_obj.
Hover labels are the labels that normally appear when the
mouse hovers over points in the plotly graph.
Args:
hover_objs (tuple of dicts):
Specifies which points to place hover labels over.
The location of the hover labels is described by a dict with
keys and'xval' and/or 'yval' or 'curveNumber' and 'pointNumber'
and optional keys 'hovermode' and 'subplot'
'xval' and 'yval' specify the (x, y) coordinates to
place the label.
'xval' and 'yval need to be close to a point drawn in a graph.
'curveNumber' and 'pointNumber' specify the trace number and
the index theof the point in that trace respectively.
'subplot' describes which axes to the coordinates refer to.
By default, it is equal to 'xy'. For example, to specify the
second x-axis and the third y-axis, set 'subplot' to 'x2y3'
'hovermode' is either 'closest', 'x', or 'y'.
When set to 'x', all data sharing the same 'x' coordinate will
be shown on screen with corresponding trace labels.
When set to 'y' all data sharing the same 'y' coordinates will
be shown on the screen with corresponding trace labels.
When set to 'closest', information about the data point closest
to where the viewer is hovering will appear.
Note: If 'hovermode' is 'x', only 'xval' needs to be set.
If 'hovermode' is 'y', only 'yval' needs to be set.
If 'hovermode' is 'closest', 'xval' and 'yval' both
need to be set.
Note: 'hovermode' can be toggled by the user in the graph
toolbar.
Note: It is not currently possible to apply multiple hover
labels to points on different axes.
Note: `hover` can only be called with multiple dicts if
'curveNumber' and 'pointNumber' are the keys of the dicts
Examples:
Initialization - Start each example below with this setup:
```
from plotly.widgets import Graph
from IPython.display import display
graph = GraphWidget('https://plot.ly/~chris/3979')
display(graph)
```
Example 1 - Apply a label to the (x, y) point (3, 2)
```
graph.hover({'xval': 3, 'yval': 2, 'hovermode': 'closest'})
```
Example 2 -Apply a labels to all the points with the x coordinate 3
```
graph.hover({'xval': 3, 'hovermode': 'x'})
```
Example 3 - Apply a label to the first point of the first trace
and the second point of the second trace.
```
graph.hover({'curveNumber': 0, 'pointNumber': 0},
{'curveNumber': 1, 'pointNumber': 1})
```
"""
# TODO: Add to graph objects
if len(hover_objs) == 1:
hover_objs = hover_objs[0]
message = {
'task': 'hover', 'selection': hover_objs, 'graphId': self._graphId
}
self._handle_outgoing_message(message)
def add_traces(self, traces, new_indices=None):
""" Add new data traces to a graph.
If `new_indices` isn't specified, they are simply appended.
Args:
traces (dict or list of dicts, or class of plotly.graph_objs):trace
new_indices (list[int]|None), optional: The final indices the
added traces should occupy in the graph.
Examples:
Initialization - Start each example below with this setup:
```
from plotly.widgets import Graph
from plotly.graph_objs import Scatter
from IPython.display import display
graph = GraphWidget('https://plot.ly/~chris/3979')
display(graph)
```
Example 1 - Add a scatter/line trace to the graph
```
graph.add_traces(Scatter(x = [1, 2, 3], y = [5, 4, 5]))
```
Example 2 - Add a scatter trace and set it to to be the
second trace. This will appear as the second
item in the legend.
```
graph.add_traces(Scatter(x = [1, 2, 3], y = [5, 6, 5]),
new_indices=[1])
```
Example 3 - Add multiple traces to the graph
```
graph.add_traces([
Scatter(x = [1, 2, 3], y = [5, 6, 5]),
Scatter(x = [1, 2.5, 3], y = [5, 8, 5])
])
```
"""
# TODO: Validate traces with graph_objs
message = {
'task': 'addTraces', 'traces': traces, 'graphId': self._graphId
}
if new_indices is not None:
message['newIndices'] = new_indices
self._handle_outgoing_message(message)
def delete_traces(self, indices):
"""Delete data traces from a graph.
Args:
indices (list[int]): The indices of the traces to be removed
Example - Delete the 2nd trace:
```
from plotly.widgets import Graph
from IPython.display import display
graph = GraphWidget('https://plot.ly/~chris/3979')
display(graph)
graph.delete_traces([1])
```
"""
message = {
'task': 'deleteTraces',
'indices': indices,
'graphId': self._graphId
}
self._handle_outgoing_message(message)
def reorder_traces(self, current_indices, new_indices=None):
"""Reorder the traces in a graph.
The order of the traces determines the order of the legend entries
and the layering of the objects drawn in the graph, i.e. the first
trace is drawn first and the second trace is drawn on top of the
first trace.
Args:
current_indices (list[int]): The index of the traces to reorder.
new_indices (list[int], optional): The index of the traces
specified by `current_indices` after ordering.
If None, then move the traces to the end.
Examples:
Example 1 - Move the first trace to the second to last
position, the second trace to the last position
```
graph.move_traces([0, 1])
```
Example 2 - Move the first trace to the second position,
the second trace to the first position.
```
graph.move_traces([0], [1])
```
"""
message = {
'task': 'moveTraces',
'currentIndices': current_indices,
'graphId': self._graphId
}
if new_indices is not None:
message['newIndices'] = new_indices
self._handle_outgoing_message(message)