-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
Copy pathFigure.js
1803 lines (1595 loc) · 60.7 KB
/
Figure.js
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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
var widgets = require("@jupyter-widgets/base");
var _ = require("lodash");
window.PlotlyConfig = {MathJaxConfig: 'local'};
var Plotly = require("plotly.js/dist/plotly.min");
var PlotlyIndex = require("plotly.js/src/lib/index");
var semver_range = "^" + require("../package.json").version;
// Model
// =====
/**
* A FigureModel holds a mirror copy of the state of a FigureWidget on
* the Python side. There is a one-to-one relationship between JavaScript
* FigureModels and Python FigureWidgets. The JavaScript FigureModel is
* initialized as soon as a Python FigureWidget initialized, this happens
* even before the widget is first displayed in the Notebook
* @type {widgets.DOMWidgetModel}
*/
var FigureModel = widgets.DOMWidgetModel.extend({
defaults: _.extend(widgets.DOMWidgetModel.prototype.defaults(), {
// Model metadata
// --------------
_model_name: "FigureModel",
_view_name: "FigureView",
_model_module: "plotlywidget",
_view_module: "plotlywidget",
_view_module_version: semver_range,
_model_module_version: semver_range,
// Data and Layout
// ---------------
// The _data and _layout properties are synchronized with the
// Python side on initialization only. After initialization, these
// properties are kept in sync through the use of the _py2js_*
// messages
_data: [],
_layout: {},
_config: {},
// Python -> JS messages
// ---------------------
// Messages are implemented using trait properties. This is done so
// that we can take advantage of ipywidget's binary serialization
// protocol.
//
// Messages are sent by the Python side by assigning the message
// contents to the appropriate _py2js_* property, and then immediately
// setting it to None. Messages are received by the JavaScript
// side by registering property change callbacks in the initialize
// methods for FigureModel and FigureView. e.g. (where this is a
// FigureModel):
//
// this.on('change:_py2js_addTraces', this.do_addTraces, this);
//
// Message handling methods, do_addTraces, are responsible for
// performing the appropriate action if the message contents are
// not null
/**
* @typedef {null|Object} Py2JsAddTracesMsg
* @property {Array.<Object>} trace_data
* Array of traces to append to the end of the figure's current traces
* @property {Number} trace_edit_id
* Edit ID to use when returning trace deltas using
* the _js2py_traceDeltas message.
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message.
*/
_py2js_addTraces: null,
/**
* @typedef {null|Object} Py2JsDeleteTracesMsg
* @property {Array.<Number>} delete_inds
* Array of indexes of traces to be deleted, in ascending order
* @property {Number} trace_edit_id
* Edit ID to use when returning trace deltas using
* the _js2py_traceDeltas message.
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message.
*/
_py2js_deleteTraces: null,
/**
* @typedef {null|Object} Py2JsMoveTracesMsg
* @property {Array.<Number>} current_trace_inds
* Array of the current indexes of traces to be moved
* @property {Array.<Number>} new_trace_inds
* Array of the new indexes that traces should be moved to.
*/
_py2js_moveTraces: null,
/**
* @typedef {null|Object} Py2JsRestyleMsg
* @property {Object} restyle_data
* Restyle data as accepted by Plotly.restyle
* @property {null|Array.<Number>} restyle_traces
* Array of indexes of the traces that the resytle operation applies
* to, or null to apply the operation to all traces
* @property {Number} trace_edit_id
* Edit ID to use when returning trace deltas using
* the _js2py_traceDeltas message
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message
* @property {null|String} source_view_id
* view_id of the FigureView that triggered the original restyle
* event (e.g. by clicking the legend), or null if the restyle was
* triggered from Python
*/
_py2js_restyle: null,
/**
* @typedef {null|Object} Py2JsRelayoutMsg
* @property {Object} relayout_data
* Relayout data as accepted by Plotly.relayout
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message
* @property {null|String} source_view_id
* view_id of the FigureView that triggered the original relayout
* event (e.g. by clicking the zoom button), or null if the
* relayout was triggered from Python
*/
_py2js_relayout: null,
/**
* @typedef {null|Object} Py2JsUpdateMsg
* @property {Object} style_data
* Style data as accepted by Plotly.update
* @property {Object} layout_data
* Layout data as accepted by Plotly.update
* @property {Array.<Number>} style_traces
* Array of indexes of the traces that the update operation applies
* to, or null to apply the operation to all traces
* @property {Number} trace_edit_id
* Edit ID to use when returning trace deltas using
* the _js2py_traceDeltas message
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message
* @property {null|String} source_view_id
* view_id of the FigureView that triggered the original update
* event (e.g. by clicking a button), or null if the update was
* triggered from Python
*/
_py2js_update: null,
/**
* @typedef {null|Object} Py2JsAnimateMsg
* @property {Object} style_data
* Style data as accepted by Plotly.animate
* @property {Object} layout_data
* Layout data as accepted by Plotly.animate
* @property {Array.<Number>} style_traces
* Array of indexes of the traces that the animate operation applies
* to, or null to apply the operation to all traces
* @property {Object} animation_opts
* Animation options as accepted by Plotly.animate
* @property {Number} trace_edit_id
* Edit ID to use when returning trace deltas using
* the _js2py_traceDeltas message
* @property {Number} layout_edit_id
* Edit ID to use when returning layout deltas using
* the _js2py_layoutDelta message
* @property {null|String} source_view_id
* view_id of the FigureView that triggered the original animate
* event (e.g. by clicking a button), or null if the update was
* triggered from Python
*/
_py2js_animate: null,
/**
* @typedef {null|Object} Py2JsRemoveLayoutPropsMsg
* @property {Array.<Array.<String|Number>>} remove_props
* Array of property paths to remove. Each propery path is an
* array of property names or array indexes that locate a property
* inside the _layout object
*/
_py2js_removeLayoutProps: null,
/**
* @typedef {null|Object} Py2JsRemoveTracePropsMsg
* @property {Number} remove_trace
* The index of the trace from which to remove properties
* @property {Array.<Array.<String|Number>>} remove_props
* Array of property paths to remove. Each propery path is an
* array of property names or array indexes that locate a property
* inside the _data[remove_trace] object
*/
_py2js_removeTraceProps: null,
// JS -> Python messages
// ---------------------
// Messages are sent by the JavaScript side by assigning the
// message contents to the appropriate _js2py_* property and then
// calling the `touch` method on the view that triggered the
// change. e.g. (where this is a FigureView):
//
// this.model.set('_js2py_restyle', data);
// this.touch();
//
// The Python side is responsible for setting the property to None
// after receiving the message.
//
// Message trigger logic is described in the corresponding
// handle_plotly_* methods of FigureView
/**
* @typedef {null|Object} Js2PyRestyleMsg
* @property {Object} style_data
* Style data that was passed to Plotly.restyle
* @property {Array.<Number>} style_traces
* Array of indexes of the traces that the restyle operation
* was applied to, or null if applied to all traces
* @property {String} source_view_id
* view_id of the FigureView that triggered the original restyle
* event (e.g. by clicking the legend)
*/
_js2py_restyle: null,
/**
* @typedef {null|Object} Js2PyRelayoutMsg
* @property {Object} relayout_data
* Relayout data that was passed to Plotly.relayout
* @property {String} source_view_id
* view_id of the FigureView that triggered the original relayout
* event (e.g. by clicking the zoom button)
*/
_js2py_relayout: null,
/**
* @typedef {null|Object} Js2PyUpdateMsg
* @property {Object} style_data
* Style data that was passed to Plotly.update
* @property {Object} layout_data
* Layout data that was passed to Plotly.update
* @property {Array.<Number>} style_traces
* Array of indexes of the traces that the update operation applied
* to, or null if applied to all traces
* @property {String} source_view_id
* view_id of the FigureView that triggered the original relayout
* event (e.g. by clicking the zoom button)
*/
_js2py_update: null,
/**
* @typedef {null|Object} Js2PyLayoutDeltaMsg
* @property {Object} layout_delta
* The layout delta object that contains all of the properties of
* _fullLayout that are not identical to those in the
* FigureModel's _layout property
* @property {Number} layout_edit_id
* Edit ID of message that triggered the creation of layout delta
*/
_js2py_layoutDelta: null,
/**
* @typedef {null|Object} Js2PyTraceDeltasMsg
* @property {Array.<Object>} trace_deltas
* Array of trace delta objects. Each trace delta contains the
* trace's uid along with all of the properties of _fullData that
* are not identical to those in the FigureModel's _data property
* @property {Number} trace_edit_id
* Edit ID of message that triggered the creation of trace deltas
*/
_js2py_traceDeltas: null,
/**
* Object representing a collection of points for use in click, hover,
* and selection events
* @typedef {Object} Points
* @property {Array.<Number>} trace_indexes
* Array of the trace index for each point
* @property {Array.<Number>} point_indexes
* Array of the index of each point in its own trace
* @property {null|Array.<Number>} xs
* Array of the x coordinate of each point (for cartesian trace types)
* or null (for non-cartesian trace types)
* @property {null|Array.<Number>} ys
* Array of the y coordinate of each point (for cartesian trace types)
* or null (for non-cartesian trace types
* @property {null|Array.<Number>} zs
* Array of the z coordinate of each point (for 3D cartesian
* trace types)
* or null (for non-3D-cartesian trace types)
*/
/**
* Object representing the state of the input devices during a
* plotly event
* @typedef {Object} InputDeviceState
* @property {boolean} alt - true if alt key pressed,
* false otherwise
* @property {boolean} ctrl - true if ctrl key pressed,
* false otherwise
* @property {boolean} meta - true if meta key pressed,
* false otherwise
* @property {boolean} shift - true if shift key pressed,
* false otherwise
*
* @property {boolean} button
* Indicates which button was pressed on the mouse to trigger the
* event.
* 0: Main button pressed, usually the left button or the
* un-initialized state
* 1: Auxiliary button pressed, usually the wheel button or
* the middle button (if present)
* 2: Secondary button pressed, usually the right button
* 3: Fourth button, typically the Browser Back button
* 4: Fifth button, typically the Browser Forward button
*
* @property {boolean} buttons
* Indicates which buttons were pressed on the mouse when the event
* is triggered.
* 0 : No button or un-initialized
* 1 : Primary button (usually left)
* 2 : Secondary button (usually right)
* 4 : Auxilary button (usually middle or mouse wheel button)
* 8 : 4th button (typically the "Browser Back" button)
* 16 : 5th button (typically the "Browser Forward" button)
*
* Combinations of buttons are represented by the sum of the codes
* above. e.g. a value of 7 indicates buttons 1 (primary),
* 2 (secondary), and 4 (auxilary) were pressed during the event
*/
/**
* @typedef {Object} BoxSelectorState
* @property {Array.<Number>} xrange
* Two element array containing the x-range of the box selection
* @property {Array.<Number>} yrange
* Two element array containing the y-range of the box selection
*/
/**
* @typedef {Object} LassoSelectorState
* @property {Array.<Number>} xs
* Array of the x-coordinates of the lasso selection region
* @property {Array.<Number>} ys
* Array of the y-coordinates of the lasso selection region
*/
/**
* Object representing the state of the selection tool during a
* plotly_select event
* @typedef {Object} Selector
* @property {String} type
* Selection type. One of: 'box', or 'lasso'
* @property {BoxSelectorState|LassoSelectorState} selector_state
*/
/**
* @typedef {null|Object} Js2PyPointsCallbackMsg
* @property {string} event_type
* Name of the triggering event. One of 'plotly_click',
* 'plotly_hover', 'plotly_unhover', or 'plotly_selected'
* @property {null|Points} points
* Points object for event
* @property {null|InputDeviceState} device_state
* InputDeviceState object for event
* @property {null|Selector} selector
* State of the selection tool for 'plotly_selected' events, null
* for other event types
*/
_js2py_pointsCallback: null,
// Message tracking
// ----------------
/**
* @type {Number}
* layout_edit_id of the last layout modification operation
* requested by the Python side
*/
_last_layout_edit_id: 0,
/**
* @type {Number}
* trace_edit_id of the last trace modification operation
* requested by the Python side
*/
_last_trace_edit_id: 0
}),
/**
* Initialize FigureModel. Called when the Python FigureWidget is first
* constructed
*/
initialize: function() {
FigureModel.__super__.initialize.apply(this, arguments);
this.on("change:_data", this.do_data, this);
this.on("change:_layout", this.do_layout, this);
this.on("change:_py2js_addTraces", this.do_addTraces, this);
this.on("change:_py2js_deleteTraces", this.do_deleteTraces, this);
this.on("change:_py2js_moveTraces", this.do_moveTraces, this);
this.on("change:_py2js_restyle", this.do_restyle, this);
this.on("change:_py2js_relayout", this.do_relayout, this);
this.on("change:_py2js_update", this.do_update, this);
this.on("change:_py2js_animate", this.do_animate, this);
this.on("change:_py2js_removeLayoutProps",
this.do_removeLayoutProps, this);
this.on("change:_py2js_removeTraceProps",
this.do_removeTraceProps, this);
},
/**
* Input a trace index specification and return an Array of trace
* indexes where:
*
* - null|undefined -> Array of all traces
* - Trace index as Number -> Single element array of input index
* - Array of trace indexes -> Input array unchanged
*
* @param {undefined|null|Number|Array.<Number>} trace_indexes
* @returns {Array.<Number>}
* Array of trace indexes
* @private
*/
_normalize_trace_indexes: function (trace_indexes) {
if (trace_indexes === null || trace_indexes === undefined) {
var numTraces = this.get("_data").length;
trace_indexes = _.range(numTraces);
}
if (!Array.isArray(trace_indexes)) {
// Make sure idx is an array
trace_indexes = [trace_indexes];
}
return trace_indexes
},
/**
* Log changes to the _data trait
*
* This should only happed on FigureModel initialization
*/
do_data: function () {
},
/**
* Log changes to the _layout trait
*
* This should only happed on FigureModel initialization
*/
do_layout: function () {
},
/**
* Handle addTraces message
*/
do_addTraces: function () {
// add trace to plot
/** @type {Py2JsAddTracesMsg} */
var msgData = this.get("_py2js_addTraces");
if (msgData !== null) {
var currentTraces = this.get("_data");
var newTraces = msgData.trace_data;
_.forEach(newTraces, function (newTrace) {
currentTraces.push(newTrace);
})
}
},
/**
* Handle deleteTraces message
*/
do_deleteTraces: function () {
// remove traces from plot
/** @type {Py2JsDeleteTracesMsg} */
var msgData = this.get("_py2js_deleteTraces");
if (msgData !== null) {
var delete_inds = msgData.delete_inds;
var tracesData = this.get("_data");
// Remove del inds in reverse order so indexes remain valid
// throughout loop
delete_inds.slice().reverse().forEach(function (del_ind) {
tracesData.splice(del_ind, 1);
});
}
},
/**
* Handle moveTraces message
*/
do_moveTraces: function () {
/** @type {Py2JsMoveTracesMsg} */
var msgData = this.get("_py2js_moveTraces");
if (msgData !== null) {
var tracesData = this.get("_data");
var currentInds = msgData.current_trace_inds;
var newInds = msgData.new_trace_inds;
performMoveTracesLike(tracesData, currentInds, newInds);
}
},
/**
* Handle restyle message
*/
do_restyle: function () {
/** @type {Py2JsRestyleMsg} */
var msgData = this.get("_py2js_restyle");
if (msgData !== null) {
var restyleData = msgData.restyle_data;
var restyleTraces = this._normalize_trace_indexes(
msgData.restyle_traces);
performRestyleLike(this.get("_data"), restyleData, restyleTraces);
}
},
/**
* Handle relayout message
*/
do_relayout: function () {
/** @type {Py2JsRelayoutMsg} */
var msgData = this.get("_py2js_relayout");
if (msgData !== null) {
performRelayoutLike(this.get("_layout"), msgData.relayout_data);
}
},
/**
* Handle update message
*/
do_update: function() {
/** @type {Py2JsUpdateMsg} */
var msgData = this.get("_py2js_update");
if (msgData !== null) {
var style = msgData.style_data;
var layout = msgData.layout_data;
var styleTraces = this._normalize_trace_indexes(
msgData.style_traces);
performRestyleLike(this.get("_data"), style, styleTraces);
performRelayoutLike(this.get("_layout"), layout);
}
},
/**
* Handle animate message
*/
do_animate: function () {
/** @type {Py2JsAnimateMsg} */
var msgData = this.get("_py2js_animate");
if (msgData !== null) {
var styles = msgData.style_data;
var layout = msgData.layout_data;
var trace_indexes = this._normalize_trace_indexes(
msgData.style_traces);
for (var i = 0; i < styles.length; i++) {
var style = styles[i];
var trace_index = trace_indexes[i];
var trace = this.get("_data")[trace_index];
performRelayoutLike(trace, style);
}
performRelayoutLike(this.get("_layout"), layout);
}
},
/**
* Handle removeLayoutProps message
*/
do_removeLayoutProps: function () {
/** @type {Py2JsRemoveLayoutPropsMsg} */
var msgData = this.get("_py2js_removeLayoutProps");
if (msgData !== null) {
var keyPaths = msgData.remove_props;
var layout = this.get("_layout");
performRemoveProps(layout, keyPaths);
}
},
/**
* Handle removeTraceProps message
*/
do_removeTraceProps: function () {
/** @type {Py2JsRemoveTracePropsMsg} */
var msgData = this.get("_py2js_removeTraceProps");
if (msgData !== null) {
var keyPaths = msgData.remove_props;
var traceIndex = msgData.remove_trace;
var trace = this.get("_data")[traceIndex];
performRemoveProps(trace, keyPaths);
}
}
}, {
serializers: _.extend({
_data: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_layout: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_addTraces: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_deleteTraces: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_moveTraces: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_restyle: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_relayout: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_update: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_animate: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_removeLayoutProps: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_py2js_removeTraceProps: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_restyle: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_relayout: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_update: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_layoutDelta: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_traceDeltas: { deserialize: py2js_deserializer,
serialize: js2py_serializer},
_js2py_pointsCallback: { deserialize: py2js_deserializer,
serialize: js2py_serializer}
}, widgets.DOMWidgetModel.serializers)
});
// View
// ====
/**
* A FigureView manages the visual presentation of a single Plotly.js
* figure for a single notebook output cell. Each FigureView has a
* reference to FigureModel. Multiple views may share a single model
* instance, as is the case when a Python FigureWidget is displayed in
* multiple notebook output cells.
*
* @type {widgets.DOMWidgetView}
*/
var FigureView = widgets.DOMWidgetView.extend({
/**
* The perform_render method is called by processPhosphorMessage
* after the widget's DOM element has been attached to the notebook
* output cell. This happens after the initialize of the
* FigureModel, and it won't happen at all if the Python FigureWidget
* is never displayed in a notebook output cell
*/
perform_render: function() {
var that = this;
// Wire up message property callbacks
// ----------------------------------
// Python -> JS event properties
this.model.on("change:_py2js_addTraces",
this.do_addTraces, this);
this.model.on("change:_py2js_deleteTraces",
this.do_deleteTraces, this);
this.model.on("change:_py2js_moveTraces",
this.do_moveTraces, this);
this.model.on("change:_py2js_restyle",
this.do_restyle, this);
this.model.on("change:_py2js_relayout",
this.do_relayout, this);
this.model.on("change:_py2js_update",
this.do_update, this);
this.model.on("change:_py2js_animate",
this.do_animate, this);
// MathJax configuration
// ---------------------
if (window.MathJax) {
MathJax.Hub.Config({SVG: {font: "STIX-Web"}});
}
// Get message ids
// ---------------------
var layout_edit_id = this.model.get("_last_layout_edit_id");
var trace_edit_id = this.model.get("_last_trace_edit_id");
// Set view UID
// ------------
this.viewID = PlotlyIndex.randstr();
// Initialize Plotly.js figure
// ---------------------------
// We must clone the model's data and layout properties so that
// the model is not directly mutated by the Plotly.js library.
var initialTraces = _.cloneDeep(this.model.get("_data"));
var initialLayout = _.cloneDeep(this.model.get("_layout"));
var config = this.model.get("_config");
Plotly.newPlot(that.el, initialTraces, initialLayout, config).then(
function () {
// ### Send trace deltas ###
// We create an array of deltas corresponding to the new
// traces.
that._sendTraceDeltas(trace_edit_id);
// ### Send layout delta ###
that._sendLayoutDelta(layout_edit_id);
// Wire up plotly event callbacks
that.el.on("plotly_restyle",
function (update) {
that.handle_plotly_restyle(update)
});
that.el.on("plotly_relayout",
function (update) {
that.handle_plotly_relayout(update)
});
that.el.on("plotly_update",
function (update) {
that.handle_plotly_update(update)
});
that.el.on("plotly_click",
function (update) {
that.handle_plotly_click(update)
});
that.el.on("plotly_hover",
function (update) {
that.handle_plotly_hover(update)
});
that.el.on("plotly_unhover",
function (update) {
that.handle_plotly_unhover(update)
});
that.el.on("plotly_selected",
function (update) {
that.handle_plotly_selected(update)
});
that.el.on("plotly_doubleclick",
function (update) {
that.handle_plotly_doubleclick(update)
});
// Emit event indicating that the widget has finished
// rendering
var event = new CustomEvent("plotlywidget-after-render",
{ "detail": {"element": that.el, 'viewID': that.viewID}});
// Dispatch/Trigger/Fire the event
document.dispatchEvent(event);
});
},
/**
* Respond to phosphorjs events
*/
processPhosphorMessage: function(msg) {
FigureView.__super__.processPhosphorMessage.apply(this, arguments);
var that = this;
switch (msg.type) {
case 'before-attach':
// Render an initial empty figure. This establishes with
// the page that the element will not be empty, avoiding
// some occasions where the dynamic sizing behavior leads
// to collapsed figure dimensions.
var axisHidden = {
showgrid: false, showline: false, tickvals: []};
Plotly.newPlot(that.el, [], {
xaxis: axisHidden, yaxis: axisHidden
});
window.addEventListener("resize", function(){
that.autosizeFigure();
});
break;
case 'after-attach':
// Rendering actual figure in the after-attach event allows
// Plotly.js to size the figure to fill the available element
this.perform_render();
break;
case 'resize':
this.autosizeFigure();
break
}
},
autosizeFigure: function() {
var that = this;
var layout = that.model.get('_layout');
if (_.isNil(layout) ||
_.isNil(layout.width)) {
Plotly.Plots.resize(that.el).then(function(){
var layout_edit_id = that.model.get(
"_last_layout_edit_id");
that._sendLayoutDelta(layout_edit_id);
});
}
},
/**
* Purge Plotly.js data structures from the notebook output display
* element when the view is destroyed
*/
destroy: function() {
Plotly.purge(this.el);
},
/**
* Return the figure's _fullData array merged with its data array
*
* The merge ensures that for any properties that el._fullData and
* el.data have in common, we return the version from el.data
*
* Named colorscales are one example of why this is needed. The el.data
* array will hold named colorscale strings (e.g. 'Viridis'), while the
* el._fullData array will hold the actual colorscale array. e.g.
*
* el.data[0].marker.colorscale == 'Viridis' but
* el._fullData[0].marker.colorscale = [[..., ...], ...]
*
* Performing the merge allows our FigureModel to retain the 'Viridis'
* string, rather than having it overridded by the colorscale array.
*
*/
getFullData: function () {
return _.mergeWith({}, this.el._fullData, this.el.data,
fullMergeCustomizer)
},
/**
* Return the figure's _fullLayout object merged with its layout object
*
* See getFullData documentation for discussion of why the merge is
* necessary
*/
getFullLayout: function () {
return _.mergeWith({}, this.el._fullLayout, this.el.layout,
fullMergeCustomizer);
},
/**
* Build Points data structure from data supplied by the plotly_click,
* plotly_hover, or plotly_select events
* @param {Object} data
* @returns {null|Points}
*/
buildPointsObject: function (data) {
var pointsObject;
if (data.hasOwnProperty("points")) {
// Most cartesian plots
var pointObjects = data["points"];
var numPoints = pointObjects.length;
pointsObject = {
"trace_indexes": new Array(numPoints),
"point_indexes": new Array(numPoints),
"xs": new Array(numPoints),
"ys": new Array(numPoints)};
for (var p = 0; p < numPoints; p++) {
pointsObject["trace_indexes"][p] =
pointObjects[p]["curveNumber"];
pointsObject["point_indexes"][p] =
pointObjects[p]["pointNumber"];
pointsObject["xs"][p] =
pointObjects[p]["x"];
pointsObject["ys"][p] =
pointObjects[p]["y"];
}
// Add z if present
var hasZ = pointObjects[0] !==
undefined && pointObjects[0].hasOwnProperty("z");
if (hasZ) {
pointsObject["zs"] = new Array(numPoints);
for (p = 0; p < numPoints; p++) {
pointsObject["zs"][p] = pointObjects[p]["z"];
}
}
return pointsObject
} else {
return null
}
},
/**
* Build InputDeviceState data structure from data supplied by the
* plotly_click, plotly_hover, or plotly_select events
* @param {Object} data
* @returns {null|InputDeviceState}
*/
buildInputDeviceStateObject: function (data) {
var event = data["event"];
if (event === undefined) {
return null;
} else {
/** @type {InputDeviceState} */
var inputDeviceState = {
// Keyboard modifiers
"alt": event["altKey"],
"ctrl": event["ctrlKey"],
"meta": event["metaKey"],
"shift": event["shiftKey"],
// Mouse buttons
"button": event["button"],
"buttons": event["buttons"]
};
return inputDeviceState
}
},
/**
* Build Selector data structure from data supplied by the
* plotly_select event
* @param data
* @returns {null|Selector}
*/
buildSelectorObject: function(data) {
var selectorObject;
if (data.hasOwnProperty("range")) {
// Box selection
selectorObject = {
type: "box",
selector_state: {
xrange: data["range"]["x"],
yrange: data["range"]["y"]
}
};
} else if (data.hasOwnProperty("lassoPoints")) {
// Lasso selection
selectorObject = {
type: "lasso",
selector_state: {
xs: data["lassoPoints"]["x"],
ys: data["lassoPoints"]["y"]
}
};
} else {
selectorObject = null;
}
return selectorObject
},
/**
* Handle ploty_restyle events emitted by the Plotly.js library
* @param data
*/
handle_plotly_restyle: function (data) {
if (data === null || data === undefined) {
// No data to report to the Python side
return
}
if (data[0] && data[0].hasOwnProperty("_doNotReportToPy")) {
// Restyle originated on the Python side
return
}
// Unpack data
var styleData = data[0];
var styleTraces = data[1];
// Construct restyle message to send to the Python side
/** @type {Js2PyRestyleMsg} */
var restyleMsg = {
style_data: styleData,
style_traces: styleTraces,
source_view_id: this.viewID
};
this.model.set("_js2py_restyle", restyleMsg);
this.touch();
},
/**
* Handle plotly_relayout events emitted by the Plotly.js library
* @param data
*/
handle_plotly_relayout: function (data) {