forked from predixdesignsystem/px-vis-timeseries
-
Notifications
You must be signed in to change notification settings - Fork 5
/
px-vis-timeseries-api.json
10902 lines (10902 loc) · 344 KB
/
px-vis-timeseries-api.json
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
{
"schema_version": "1.0.0",
"elements": [
{
"description": "Creates an interactive timeseries chart\n\n### Usage\n\n <px-vis-timeseries\n chart-data=\"[[chartData]]\"\n series-config=\"[[seriesConfig]]\">\n </px-vis-timeseries>\n\n### Styling\nThe following custom properties are available for styling:\n\nCustom property | Description\n----------------|-------------\n `--px-vis-axis-color` | The color for the axis lines, axis ticks, and axis tick labels\n `--px-vis-axis-title-color` | The color for the axis title\n `--px-vis-axis-inline-title-color` | The color for the axis title\n `--px-vis-axis-inline-type-color` | The color for the axis lines, axis ticks, and axis tick labels when using 'inline' labelPosition\n `--px-vis-axis-inline-box-color` | The color for the tick boxes when using 'inline' labelPosition\n |\n |\n |\n `--px-vis-nav-brush-outline-color` | The stroke (border) color for the brushed box\n `--px-vis-nav-brush-fill-color` | The fill (background) color for the brushed box\n `--px-vis-nav-brush-opacity` | The opacity of the brushed box\n `--px-vis-nav-brush-gradient-fill-color` | The fill (background) color for the brushed box when gradientOverlay is 'true'\n `--px-vis-nav-brush-gradient-opacity-1` | The start opacity of the brushed box when gradientOverlay is 'true'\n `--px-vis-nav-brush-gradient-opacity-2` | The end opacity of the brushed box when gradientOverlay is 'true'\n `--px-vis-nav-brush-handle-fill-color` | The fill (background) color for the handles on the brushed box\n `--px-vis-nav-brush-handle-lines-color` | The stroke (border) color for the handles on the brushed box\n `--px-vis-nav-brush-handle-fill-color-hover` | The hover state fill (background) color for the handles on the brushed box\n `--px-vis-nav-brush-handle-lines-color-hover` | The hover state stroke (border) color for the handles on the brushed box\n `--px-vis-nav-brush-handle-fill-color-press` | The pressed/mousedown state fill (background) color for the handles on the brushed box\n `--px-vis-nav-brush-handle-lines-color-press` | The pressed/mousedown state stroke (border) color for the handles on the brushed box\n |\n |\n |\n `--px-vis-cursor-line-color` | The color for the lines which track the cursor/data\n |\n |\n |\n `--px-vis-event-line-color` | The default color for the vertical lines below the icon\n `--px-vis-event-icon-color` | The default color for the event icon markers\n |\n |\n |\n `--px-vis-gridlines-color` | The color for the gridlines\n |\n |\n |\n `--px-vis-threshold-color` | The default color for a threshold\n |\n |\n |\n `--px-vis-zoom-brush-outline-color` | The stroke (border) color for the on-chart zoom/selection brush\n `--px-vis-zoom-brush-fill-color` | The fill (background) color for the on-chart zoom/selection brush\n `--px-vis-zoom-brush-fill-opacity` | The opacity for the on-chart zoom/selection brush\n |\n |\n |\n `--px-vis-register-series-name` | The color of the data series name\n `--px-vis-register-data-value` | The color of the data series value\n `--px-vis-register-box` | The color of the box around the register when a scrollbar is present\n |\n |\n |\n `--px-vis-series-color-0` | These are the colors used to represent the data series on the charts. Used in numerical order by default. Colors MUST start at 0 and cannot contain gaps between numbers.\n `--px-vis-series-color-1` |\n `--px-vis-series-color-2` |\n `--px-vis-series-color-n` |\n |\n |\n |\n `--px-tooltip-background-color` | The color of the tooltip\n `--px-tooltip-text-color` | The color of the tooltip text\n `--px-tooltip-light-background-color` | The color of the light version tooltip\n `--px-tooltip-light-text-color` | The color of the light version tooltip text\n `--px-tooltip-light-border-color`| The color of the light version tooltip border\n |\n |\n |\n `--px-vis-font-family` | The font family for all labels and text",
"summary": "",
"path": "px-vis-timeseries.html",
"properties": [
{
"name": "width",
"type": "number",
"description": "The width of the elem; generally the width of the charting area for most components",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 47,
"column": 4
},
"end": {
"line": 50,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.baseSize"
},
{
"name": "height",
"type": "number",
"description": "The height of the component; generally the height of the charting area for most components.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 56,
"column": 4
},
"end": {
"line": 59,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.baseSize"
},
{
"name": "_defaultMargin",
"type": "Object",
"description": "Copy of the default margin for checking if it has changed",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 79,
"column": 4
},
"end": {
"line": 89,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"inheritedFrom": "PxVisBehavior.margins"
},
{
"name": "margin",
"type": "Object",
"description": "Defines the base margin for the chart. Calcs are run to add to the margin to accommodate axes and other elements which exist within the SVG frame, but outside the chart frame.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 94,
"column": 4
},
"end": {
"line": 104,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"inheritedFrom": "PxVisBehavior.margins"
},
{
"name": "chartData",
"type": "Array",
"description": "container for the data object that drives the chart / component\nGenerally loaded with an iron-ajax tag (but doesnt have to be)\nThis can be set declaratively",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 345,
"column": 6
},
"end": {
"line": 347,
"column": 7
}
},
"metadata": {
"polymer": {}
},
"inheritedFrom": "PxVisBehavior.dataset"
},
{
"name": "completeSeriesConfig",
"type": "Object",
"description": "A configuration file generated by the chart behavior based on seriesConfig and defaultSeriesConfig.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 384,
"column": 7
},
"end": {
"line": 387,
"column": 8
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.completeSeriesConfig"
},
{
"name": "mutedSeries",
"type": "Object",
"description": "A list of user selected muted series. Tied declaratively to series components\n\nThe series name is the key and the value is a boolean for whether it is muted or not:\n\n```\n{\n 'seriesId1':true,\n 'seriesId2':false,\n }\n```\n\nIn this example, seriesId1 is muted. seriesId2 was muted, but has been turned back on.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 446,
"column": 4
},
"end": {
"line": 450,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"defaultValue": "{}",
"inheritedFrom": "PxVisBehavior.mutedSeries"
},
{
"name": "hardMute",
"type": "boolean",
"description": "Allows for a \"hard\" muting of the series/categories: the\nseries/category won't show up\nin the tooltip anymore, it's tooltip data won't be shown in the register\nand its extents won't be taken into account by the chart",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 457,
"column": 5
},
"end": {
"line": 460,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehavior.mutedSeries"
},
{
"name": "tooltipData",
"type": "Object",
"description": "Data reported back by the interaction space component. Displays the series name, values, and timestamp in the register. tooltipData is in the form:\n\n```\n {\n \"time\": \"2015-03-25T20:34:47.085Z\",\n \"hidden\": false,\n \"series\":[{\n \"name\":\"seriesId1\",\n \"coord\":[xCoord1, yCoord1], //in pixel space\n \"value\":{\n \"x\":xVal1, //in data space\n \"seriesId1\":yVal1 //in data space\n }\n },{\n \"name\":\"seriesId2\",\n \"coord\":[xCoord2, yCoord2], //in pixel space\n \"value\":{\n \"x\":xVal2, //in data space\n \"seriesId2\":yVal2 //in data space\n },\n }],\n \"mouse\":[ mouseX, mouseY ], //in pixel space\n \"xArr\":[xCoord1 , xCoord2], //in pixel space\n \"yArr\":[yCoord1 , yCoord2], //in pixel space\n }\n```\n\nWhen not hovering on a chart, the tooltipData should still have the series names in order for them to still appear in the register. IE:\n\n```\n {\n \"time\": null,\n \"hidden\": true,\n \"series\":[{\n \"name\":\"seriesId1\",\n \"value\": null\n },{\n \"name\":\"seriesName1\",\n \"value\": null\n }],\n \"mouse\": null,\n \"xArr\": null,\n \"yArr\": null\n }\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 662,
"column": 4
},
"end": {
"line": 665,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.tooltipData"
},
{
"name": "defaultEmptyData",
"type": "Object",
"description": "The \"empty\" dataset that should be used for tooltipData when not hovering",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 670,
"column": 4
},
"end": {
"line": 674,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"defaultValue": "null",
"inheritedFrom": "PxVisBehavior.tooltipData"
},
{
"name": "extentsData",
"type": "Object",
"description": "Data reported back by the interaction space. Displays the interpreted x & y coords, width and height, and domain extents. extentsData is in the form:\n\n```\n {\n x1 = {pixel-space}\n y1 = {pixel-space}\n x2 = {pixel-space}\n y2 = {pixel-space}\n w = {pixels}\n h = {pixels}\n eX = [{domain}, {domain}];\n eY = [{domain}, {domain}];\n }\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 771,
"column": 4
},
"end": {
"line": 774,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.extentsData"
},
{
"name": "extentsAction",
"type": "string",
"description": "Used by the chart to interpret if extentsData is strip or zoom",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 778,
"column": 4
},
"end": {
"line": 781,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.extentsData"
},
{
"name": "selectionType",
"type": "string",
"description": "The zoom selection type:\n- xy\n- xAxis\n- yAxis",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 2309,
"column": 4
},
"end": {
"line": 2313,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"defaultValue": "\"xy\"",
"inheritedFrom": "PxVisBehavior.selectionType"
},
{
"name": "chartExtents",
"type": "Object",
"description": "Developer set chart extents for the chart. The chart will draw to whatever values are specified in the chartExtents.\nSetting this and not using \"dynamic\" will prevent the chart from\nhaving to parse the data to find the extents and therefore improve\nperformance for initial rendering\n```\n {\n \"x\": [0,100],\n \"y\": [5,50],\n }\n```\n\nTo force the chart to calculate based on data, use \"dynamic\".\n```\n {\n \"x\": [0,\"dynamic\"],\n \"y\": [-10,\"dynamic\"],\n }\n```\n\nFor an ordinal dataset, chart extents can be set like this:\n```\n {\n \"x\": ['low','medium','high'],\n \"y\": [5,50],\n }\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1162,
"column": 4
},
"end": {
"line": 1165,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.chartExtents"
},
{
"name": "dataExtents",
"type": "Object",
"description": "```\n {\n \"x\": [0,100],\n \"y\": [5,50],\n }\n```\n\nFor an ordinal dataset, chart extents can be set like this:\n```\n {\n \"x\": ['low','medium','high'],\n \"y\": [5,50],\n }\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1198,
"column": 4
},
"end": {
"line": 1201,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehavior.dataExtents"
},
{
"name": "eventConfig",
"type": "Object",
"description": "Configuration object to define what event should map to what icon and color.\nThe object has a key being the event name, the value being a configuration object for that event. The configuration object has four properties:\n- `color`: A valid color name found in the px-colors-design\n- `icon`: the reference to the icon; for 'px' it is an icon set and an icon name; for an image, it is a path\n- `type`: 'px', or 'image'.\n- `offset`: a 2 element array with the number of pixels to offset the icon. offset[0] is along the x-axis; offset[1] is along the y-axis; necessary for some icons to adjust their values to achieve a better alignment over the event line.\n- `size`: a size in pixels for images.\n- `enableTooltip` enable/disable tooltip on the event, useful when using a lot of events\n- `firstDateTimeFormat`: moment.js format string for the first part of the timestamp if the x Axis is time based\n- `separator`: the separator character between the two datetime strings\n- `secondDateTimeFormat`: moment.js format string for the second part of the timestamp if the x Axis is time based\n- `tooltipOrientation`: orientation of the tooltip\n- `timezone`: the moment.js timezone to be used for the timestamp\n```\nFormat: {\n \"Event-Name-A\":{\n \"color\": \"a color, rgb or hex\",\n \"icon\": \"a px icon\",\n \"type\": \"px\",\n \"offset\":[0,0],\n 'enableTooltip': true\n },\n \"Event-Name-C\":{\n \"color\": \"a color, rgb or hex\",\n \"icon\": \"path-to-an-img\",\n \"type\": \"image\",\n \"offset\":[0,0]\n },\n}\n```\n\n```\nExample: {\n \"Recalibrate\":{\n \"color\": \"rgb(0,0,255)\",\n \"icon\": \"px-vis:mov\",\n \"type\": \"px\",\n \"offset\":[-3,0]\n },\n \"Fan stop\":{\n \"icon\": \"Dancing_banana.gif\",\n \"type\": \"image\",\n \"offset\":[-2,-20],\n \"size\":\"25\"\n }\n}\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1297,
"column": 4
},
"end": {
"line": 1299,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"inheritedFrom": "PxVisBehavior.events"
},
{
"name": "defaultEventConfig",
"type": "Object",
"description": "Configuration object to define what the default icon should be. This gets used if a) no eventConfig is defined or b) the particular event is not defined in the eventConfig object.\n\n```\nDefault: {\n 'color': 'grey7', //or theme var\n 'icon': 'px-vis:mov',\n 'type': 'px',\n 'offset': 0,\n 'lineColor': 'grey9',\n 'lineWeght': 1,\n 'enableTooltip': true\n 'firstDateTimeFormat': 'HH:mm:ss ZZ',\n 'secondDateTimeFormat': 'DD MMM YYYY',\n 'separator': '|',\n 'timezone': 'utc',\n 'tooltipOrientation': 'left'\n}\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1323,
"column": 4
},
"end": {
"line": 1325,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"inheritedFrom": "PxVisBehavior.events"
},
{
"name": "_defaultDefaultEventConfig",
"type": "Object",
"description": "Default defaultEventConfig\n\n```\nDefault: {\n 'color': 'rgb(0,0,0)',\n 'icon': 'px-utl:information',\n 'type': 'px',\n 'offset': 0,\n 'size': 16,\n 'lineColor': 'rgb(0,0,0)',\n 'lineWeight': 1,\n 'enableTooltip': true,\n 'firstDateTimeFormat': 'HH:mm:ss ZZ',\n 'secondDateTimeFormat': 'DD MMM YYYY',\n 'separator': '|',\n 'timezone': 'utc',\n 'tooltipOrientation': 'left'\n}\n```",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1348,
"column": 4
},
"end": {
"line": 1367,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "{\"color\":\"rgb(0,0,0)\",\"icon\":\"px-utl:information\",\"type\":\"px\",\"offset\":[0,0],\"size\":16,\"lineColor\":\"rgb(0,0,0)\",\"lineWeight\":1,\"enableTooltip\":true,\"firstDateTimeFormat\":\"HH:mm:ss ZZ\",\"secondDateTimeFormat\":\"DD MMM YYYY\",\"separator\":\"|\",\"timezone\":\"utc\",\"tooltipOrientation\":\"left\"}",
"inheritedFrom": "PxVisBehavior.events"
},
{
"name": "eventData",
"type": "Array",
"description": "container for the data object that drives the events\nGenerally loaded with an iron-ajax tag (but doesnt have to be)\nThis can be set declaratively",
"privacy": "public",
"sourceRange": {
"start": {
"line": 685,
"column": 6
},
"end": {
"line": 688,
"column": 7
}
},
"metadata": {
"polymer": {
"notify": true
}
}
},
{
"name": "svg",
"type": "Object",
"description": "svg is a holder for the d3 instantiated svg container to draw to.\nMust be set in ready and passed to all components so they know whom to draw to.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 30,
"column": 4
},
"end": {
"line": 33,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.svg"
},
{
"name": "_uniqueIdsUsed",
"type": "Array",
"description": "Array of unique IDs generated for this comp. cleaned from global\nstore on detached",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 2222,
"column": 5
},
"end": {
"line": 2227,
"column": 6
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "[]",
"inheritedFrom": "PxVisBehavior.uniqueIds"
},
{
"name": "pxSvgElem",
"type": "Object",
"description": "",
"privacy": "public",
"sourceRange": {
"start": {
"line": 689,
"column": 6
},
"end": {
"line": 692,
"column": 7
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "{}"
},
{
"name": "pxSvgElemLower",
"type": "Object",
"description": "The SVG element inside the chart - not a D3 selected element. Used when there are two svgs in a chart",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 277,
"column": 4
},
"end": {
"line": 280,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.svgLower"
},
{
"name": "canvasLayersConfig",
"type": "Object",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 2736,
"column": 4
},
"end": {
"line": 2739,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "{}",
"inheritedFrom": "PxVisBehavior.canvasLayersConfig"
},
{
"name": "canvasContext",
"type": "Object",
"description": "canvasContext is a holder for the instantiated canvas context to draw to.\nMust be set in ready and passed to all components so they know whom to draw to.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 303,
"column": 4
},
"end": {
"line": 306,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.canvasContext"
},
{
"name": "canvasLayers",
"type": "Object",
"description": "An array of the generated layers",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 312,
"column": 4
},
"end": {
"line": 316,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"defaultValue": "{}",
"inheritedFrom": "PxVisBehaviorD3.canvasContext"
},
{
"name": "_isAttached",
"type": "boolean",
"description": "Boolean tracking if we are attached",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 2376,
"column": 4
},
"end": {
"line": 2379,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehavior.isAttached"
},
{
"name": "renderToCanvas",
"type": "boolean",
"description": "Boolean to specify if drawings should render to canvas instead of svg",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 381,
"column": 4
},
"end": {
"line": 385,
"column": 5
}
},
"metadata": {
"polymer": {
"observer": "\"_renderToCanvasChanged\""
}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehaviorD3.renderToCanvas"
},
{
"name": "x",
"type": "Object",
"description": "x is a holder for the d3 instantiated scale object\nMust be set in the svg component and passed to all components so they know the drawing scale.\nThis can be set declaratively\n\nSee: https://github.com/d3/d3/blob/master/API.md#scales-d3-scale",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 429,
"column": 4
},
"end": {
"line": 432,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.axes"
},
{
"name": "y",
"type": "Object",
"description": "y is a holder for the d3 instantiated scale object\nMust be set in the svg component and passed to all components so they know the drawing scale.\nThis can be set declaratively\n\nSee: https://github.com/d3/d3/blob/master/API.md#scales-d3-scale",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 443,
"column": 4
},
"end": {
"line": 446,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.axes"
},
{
"name": "isMultiY",
"type": "boolean",
"description": "",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 447,
"column": 4
},
"end": {
"line": 451,
"column": 5
}
},
"metadata": {
"polymer": {
"readOnly": true
}
},
"inheritedFrom": "PxVisBehaviorD3.axes"
},
{
"name": "selectedDomain",
"type": "Object",
"description": "New chart extents selected by the user\n\nServes as a trigger for the scale component to redefine the chart extents",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 645,
"column": 4
},
"end": {
"line": 651,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.selectedDomain"
},
{
"name": "range",
"type": "Object",
"description": "Range object defining the time span\n * Format ISO8601 strings\n```\n{\n \"from\": \"2013-01-07T22:44:30.652Z\",\n \"to\" : \"2013-02-04T22:44:30.652Z\"\n}\n```\n\nUpdates and is updated by SelectedDomain",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 683,
"column": 4
},
"end": {
"line": 686,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.selectedTimeDomain"
},
{
"name": "_preventDomainUpdate",
"type": "boolean",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 687,
"column": 4
},
"end": {
"line": 690,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehaviorD3.selectedTimeDomain"
},
{
"name": "_preventRangeUpdate",
"type": "boolean",
"description": "",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 691,
"column": 4
},
"end": {
"line": 694,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehaviorD3.selectedTimeDomain"
},
{
"name": "clipPath",
"type": "string",
"description": "Holder for a clipping path ID",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 798,
"column": 4
},
"end": {
"line": 801,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.clipPath"
},
{
"name": "seriesClipPath",
"type": "string",
"description": "A more restricting clip path used to limit where the series are being drawn",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-d3.html",
"start": {
"line": 806,
"column": 4
},
"end": {
"line": 809,
"column": 5
}
},
"metadata": {
"polymer": {
"notify": true
}
},
"inheritedFrom": "PxVisBehaviorD3.clipPath"
},
{
"name": "seriesColorList",
"type": "Array",
"description": "Defines an colors in order that will be used for series.",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-colors.html",
"start": {
"line": 19,
"column": 4
},
"end": {
"line": 27,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "[\"rgb(0,0,0)\",\"rgb(75,75,75)\",\"rgb(125,125,125)\",\"rgb(200,200,200)\"]",
"inheritedFrom": "PxColorsBehavior.dataVisColors"
},
{
"name": "xAxisType",
"type": "string",
"description": "Sets the type of data for the x values\n\nValid entries are:\n- `ordinal`: for discrete input domains, such as names or categories.\n- `time`: for time domains.\n- `timeLocal`: for local time domains.\n- `linear`: for continuous input domains, such as numbers.\n- `pie`: for pie/donut charts",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1072,
"column": 4
},
"end": {
"line": 1075,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "\"linear\"",
"inheritedFrom": "PxVisBehavior.axisTypes"
},
{
"name": "yAxisType",
"type": "string",
"description": "Sets the type of data for the y values\n\nValid entries are:\n- `ordinal`: for discrete input domains, such as names or categories.\n- `linear`: for continuous input domains, such as numbers.\n- `pie`: for pie/donut charts",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-common.html",
"start": {
"line": 1084,
"column": 4
},
"end": {
"line": 1087,
"column": 5
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "\"linear\"",
"inheritedFrom": "PxVisBehavior.axisTypes"
},
{
"name": "seriesConfig",
"type": "Object",
"description": "A configuration file to associate series order, name, type, and colors.\n\nAssociation of name, type, and seriesNumber should be developer set. Color and axis are optional.\n\n```\n {\n \"seriesKey\": { //seriesKey is a unique identifier for the configuration\n \"type\": \"line\", //line or scatter or both\n \"markerSymbol\": \"diamond\" //if using scatter different markerSymbol can be used. See \"markerSymbol\" in px-vis-scatter\n \"markerSize\": \"64\" //if using scatter allows to change the size of markers\n \"markerScale\": \"2\" //if using scatter allows to scale the size of markers\n \"markerFillOpacity\": \"0.5\" //if using scatter allows to specify the opacity of the inside of the marker\n \"markerStrokeOpacity\": \"1\" //if using scatter allows to specify the opacity of the outside of the marker\n \"strokeWidth\": \"1\" //if using line, allows you to specify the thickness of the line\n \"mutedOpacity\": \"0.3\" //opacity value to use when muting a serie\n \"name\": \"My Series\", //human readable name\n \"x\": \"x\", //index or key name for independent variable\n \"y\": \"y\", //index or key name for dependent variable\n \"xAxisUnit\": \"Volt\" //Unit to be used for the X axis. Can be ignored if x axis is time based\n \"yAxisUnit\": \"Oranges\" //unit to be used for the Y axis.\n \"xMin\": 0, // minimum x value\n \"xMax\": 100, //maximum x value\n \"yMin\": 5, //minimum y value\n \"yMax\": 50, //maximum y value\n \"color\": \"rgb(0,0,0)\", //color you want the chart\n \"interpolationFunction\": Px.d3.curveBasis, //The line interpretor you want to use. See property 'interpolationFunction'\n \"axis\": {\n \"id\": \"AXIS_ID\" //a unique identifier\n \"side\": \"left\" //the side that you want the axis to draw on, `left` or `right`\n \"number\": 1 //the order of the axis on each side\n }\n }\n }\n```",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-chart.html",
"start": {
"line": 89,
"column": 6
},
"end": {
"line": 94,
"column": 7
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "{}",
"inheritedFrom": "PxVisBehaviorChart.chartCommon"
},
{
"name": "_defaultSeriesConfig",
"type": "Object",
"description": "A default configuration file. It fills in the missing parts of seriesConfig. Any options from seriesConfig can be specified in the defaultSeriesConfig and will be automatically used if not defined in the seriesConfig\n\nDefault:\n\n```\n {\n \"type\": \"line\",\n \"x\": 'x',\n \"axis\": {\n \"id\": \"defaultAxis\",\n \"side\": \"left\",\n \"number\": 1\n }}\n```",
"privacy": "protected",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-chart.html",
"start": {
"line": 112,
"column": 6
},
"end": {
"line": 125,
"column": 7
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "{\"type\":\"line\",\"x\":\"x\",\"axis\":{\"id\":\"defaultAxis\",\"side\":\"left\",\"number\":1}}",
"inheritedFrom": "PxVisBehaviorChart.chartCommon"
},
{
"name": "defaultSeriesConfig",
"type": "Object",
"description": "Overwrites to the default configuration file. The defaultSeriesConfig is used to fill in the missing parts of seriesConfig. Any option from seriesConfig can be specified in the defaultSeriesConfig and will be automatically used if not defined in the seriesConfig",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-chart.html",
"start": {
"line": 131,
"column": 6
},
"end": {
"line": 135,
"column": 7
}
},
"metadata": {
"polymer": {
"observer": "\"_updateDSC\""
}
},
"defaultValue": "{}",
"inheritedFrom": "PxVisBehaviorChart.chartCommon"
},
{
"name": "includeAllSeries",
"type": "boolean",
"description": "A boolean flag on whether to include all the series in the data.\n- `false`: only series defined in the seriesConfig file will be drawn\n- `true`: All series in the dataset will be drawn. Defaults will be used for the seriesConfig. If this is used do not specify a seriesConfig",
"privacy": "public",
"sourceRange": {
"file": "bower_components/px-vis/px-vis-behavior-chart.html",
"start": {
"line": 142,
"column": 6
},
"end": {
"line": 145,
"column": 7
}
},
"metadata": {
"polymer": {}
},
"defaultValue": "false",
"inheritedFrom": "PxVisBehaviorChart.chartCommon"
},
{
"name": "_seriesKeys",