-
Notifications
You must be signed in to change notification settings - Fork 20
/
v4.0.2.json
16632 lines (16632 loc) · 772 KB
/
v4.0.2.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
{
"$ref": "#/definitions/TopLevelSpec",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"Aggregate": {
"anyOf": [
{
"$ref": "#/definitions/NonArgAggregateOp"
},
{
"$ref": "#/definitions/ArgmaxDef"
},
{
"$ref": "#/definitions/ArgminDef"
}
]
},
"AggregateOp": {
"enum": [
"argmax",
"argmin",
"average",
"count",
"distinct",
"max",
"mean",
"median",
"min",
"missing",
"q1",
"q3",
"ci0",
"ci1",
"stderr",
"stdev",
"stdevp",
"sum",
"valid",
"values",
"variance",
"variancep"
],
"type": "string"
},
"AggregateTransform": {
"additionalProperties": false,
"properties": {
"aggregate": {
"description": "Array of objects that define fields to aggregate.",
"items": {
"$ref": "#/definitions/AggregatedFieldDef"
},
"type": "array"
},
"groupby": {
"description": "The data fields to group by. If not specified, a single group containing all data objects will be used.",
"items": {
"$ref": "#/definitions/FieldName"
},
"type": "array"
}
},
"required": [
"aggregate"
],
"type": "object"
},
"AggregatedFieldDef": {
"additionalProperties": false,
"properties": {
"as": {
"$ref": "#/definitions/FieldName",
"description": "The output field names to use for each aggregated field."
},
"field": {
"$ref": "#/definitions/FieldName",
"description": "The data field for which to compute aggregate function. This is required for all aggregation operations except `\"count\"`."
},
"op": {
"$ref": "#/definitions/AggregateOp",
"description": "The aggregation operation to apply to the fields (e.g., `\"sum\"`, `\"average\"`, or `\"count\"`).\nSee the [full list of supported aggregation operations](https://vega.github.io/vega-lite/docs/aggregate.html#ops)\nfor more information."
}
},
"required": [
"op",
"as"
],
"type": "object"
},
"Align": {
"enum": [
"left",
"center",
"right"
],
"type": "string"
},
"AllSortString": {
"anyOf": [
{
"$ref": "#/definitions/SortOrder"
},
{
"$ref": "#/definitions/SortByChannel"
},
{
"$ref": "#/definitions/SortByChannelDesc"
}
]
},
"AnyMark": {
"anyOf": [
{
"$ref": "#/definitions/CompositeMark"
},
{
"$ref": "#/definitions/CompositeMarkDef"
},
{
"$ref": "#/definitions/Mark"
},
{
"$ref": "#/definitions/MarkDef"
}
]
},
"AreaConfig": {
"additionalProperties": false,
"properties": {
"align": {
"$ref": "#/definitions/Align",
"description": "The horizontal alignment of the text or ranged marks (area, bar, image, rect, rule). One of `\"left\"`, `\"right\"`, `\"center\"`."
},
"angle": {
"description": "The rotation angle of the text, in degrees.",
"maximum": 360,
"minimum": 0,
"type": "number"
},
"aspect": {
"description": "Whether to keep aspect ratio of image marks.",
"type": "boolean"
},
"baseline": {
"$ref": "#/definitions/TextBaseline",
"description": "The vertical alignment of the text or ranged marks (area, bar, image, rect, rule). One of `\"top\"`, `\"middle\"`, `\"bottom\"`.\n\n__Default value:__ `\"middle\"`"
},
"color": {
"anyOf": [
{
"$ref": "#/definitions/Color"
},
{
"$ref": "#/definitions/Gradient"
}
],
"description": "Default color.\n\n__Default value:__ <span style=\"color: #4682b4;\">■</span> `\"#4682b4\"`\n\n__Note:__\n- This property cannot be used in a [style config](https://vega.github.io/vega-lite/docs/mark.html#style-config).\n- The `fill` and `stroke` properties have higher precedence than `color` and will override `color`."
},
"cornerRadius": {
"description": "The radius in pixels of rounded rectangle corners.\n\n__Default value:__ `0`",
"type": "number"
},
"cornerRadiusBottomLeft": {
"description": "The radius in pixels of rounded rectangle bottom left corner.\n\n__Default value:__ `0`",
"type": "number"
},
"cornerRadiusBottomRight": {
"description": "The radius in pixels of rounded rectangle bottom right corner.\n\n__Default value:__ `0`",
"type": "number"
},
"cornerRadiusTopLeft": {
"description": "The radius in pixels of rounded rectangle top right corner.\n\n__Default value:__ `0`",
"type": "number"
},
"cornerRadiusTopRight": {
"description": "The radius in pixels of rounded rectangle top left corner.\n\n__Default value:__ `0`",
"type": "number"
},
"cursor": {
"$ref": "#/definitions/Cursor",
"description": "The mouse cursor used over the mark. Any valid [CSS cursor type](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#Values) can be used."
},
"dir": {
"$ref": "#/definitions/Dir",
"description": "The direction of the text. One of `\"ltr\"` (left-to-right) or `\"rtl\"` (right-to-left). This property determines on which side is truncated in response to the limit parameter.\n\n__Default value:__ `\"ltr\"`"
},
"dx": {
"description": "The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"dy": {
"description": "The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.",
"type": "number"
},
"ellipsis": {
"description": "The ellipsis string for text truncated in response to the limit parameter.\n\n__Default value:__ `\"…\"`",
"type": "string"
},
"fill": {
"anyOf": [
{
"$ref": "#/definitions/Color"
},
{
"$ref": "#/definitions/Gradient"
},
{
"type": "null"
}
],
"description": "Default Fill Color. This has higher precedence than `config.color`.\n\n__Default value:__ (None)"
},
"fillOpacity": {
"description": "The fill opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"filled": {
"description": "Whether the mark's color should be used as fill color instead of stroke color.\n\n__Default value:__ `false` for all `point`, `line`, and `rule` marks as well as `geoshape` marks for [`graticule`](https://vega.github.io/vega-lite/docs/data.html#graticule) data sources; otherwise, `true`.\n\n__Note:__ This property cannot be used in a [style config](https://vega.github.io/vega-lite/docs/mark.html#style-config).",
"type": "boolean"
},
"font": {
"description": "The typeface to set the text in (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"fontSize": {
"description": "The font size, in pixels.",
"type": "number"
},
"fontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "The font style (e.g., `\"italic\"`)."
},
"fontWeight": {
"$ref": "#/definitions/FontWeight",
"description": "The font weight.\nThis can be either a string (e.g `\"bold\"`, `\"normal\"`) or a number (`100`, `200`, `300`, ..., `900` where `\"normal\"` = `400` and `\"bold\"` = `700`)."
},
"height": {
"description": "Height of the marks.",
"type": "number"
},
"href": {
"description": "A URL to load upon mouse click. If defined, the mark acts as a hyperlink.",
"format": "uri",
"type": "string"
},
"interpolate": {
"$ref": "#/definitions/Interpolate",
"description": "The line interpolation method to use for line and area marks. One of the following:\n- `\"linear\"`: piecewise linear segments, as in a polyline.\n- `\"linear-closed\"`: close the linear segments to form a polygon.\n- `\"step\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"step-before\"`: alternate between vertical and horizontal segments, as in a step function.\n- `\"step-after\"`: alternate between horizontal and vertical segments, as in a step function.\n- `\"basis\"`: a B-spline, with control point duplication on the ends.\n- `\"basis-open\"`: an open B-spline; may not intersect the start or end.\n- `\"basis-closed\"`: a closed B-spline, as in a loop.\n- `\"cardinal\"`: a Cardinal spline, with control point duplication on the ends.\n- `\"cardinal-open\"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.\n- `\"cardinal-closed\"`: a closed Cardinal spline, as in a loop.\n- `\"bundle\"`: equivalent to basis, except the tension parameter is used to straighten the spline.\n- `\"monotone\"`: cubic interpolation that preserves monotonicity in y."
},
"invalid": {
"description": "Defines how Vega-Lite should handle marks for invalid values (`null` and `NaN`).\n- If set to `\"filter\"` (default), all data items with null values will be skipped (for line, trail, and area marks) or filtered (for other marks).\n- If `null`, all data items are included. In this case, invalid values will be interpreted as zeroes.",
"enum": [
"filter",
null
],
"type": [
"string",
"null"
]
},
"limit": {
"description": "The maximum length of the text mark in pixels. The text value will be automatically truncated if the rendered size exceeds the limit.\n\n__Default value:__ `0`, indicating no limit",
"type": "number"
},
"line": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/OverlayMarkDef"
}
],
"description": "A flag for overlaying line on top of area marks, or an object defining the properties of the overlayed lines.\n\n- If this value is an empty object (`{}`) or `true`, lines with default properties will be used.\n\n- If this value is `false`, no lines would be automatically added to area marks.\n\n__Default value:__ `false`."
},
"lineBreak": {
"description": "A delimiter, such as a newline character, upon which to break text strings into multiple lines. This property will be ignored if the text property is array-valued.",
"type": "string"
},
"lineHeight": {
"description": "The height, in pixels, of each line of text in a multi-line text mark.",
"type": "number"
},
"opacity": {
"description": "The overall opacity (value between [0,1]).\n\n__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"order": {
"description": "For line and trail marks, this `order` property can be set to `null` or `false` to make the lines use the original order in the data sources.",
"type": [
"null",
"boolean"
]
},
"orient": {
"$ref": "#/definitions/Orientation",
"description": "The orientation of a non-stacked bar, tick, area, and line charts.\nThe value is either horizontal (default) or vertical.\n- For bar, rule and tick, this determines whether the size of the bar and tick\nshould be applied to x or y dimension.\n- For area, this property determines the orient property of the Vega output.\n- For line and trail marks, this property determines the sort order of the points in the line\nif `config.sortLineBy` is not specified.\nFor stacked charts, this is always determined by the orientation of the stack;\ntherefore explicitly specified value will be ignored."
},
"point": {
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/definitions/OverlayMarkDef"
},
{
"enum": [
"transparent"
],
"type": "string"
}
],
"description": "A flag for overlaying points on top of line or area marks, or an object defining the properties of the overlayed points.\n\n- If this property is `\"transparent\"`, transparent points will be used (for enhancing tooltips and selections).\n\n- If this property is an empty object (`{}`) or `true`, filled points with default properties will be used.\n\n- If this property is `false`, no points would be automatically added to line or area marks.\n\n__Default value:__ `false`."
},
"radius": {
"description": "Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.",
"minimum": 0,
"type": "number"
},
"shape": {
"description": "Shape of the point marks. Supported values include:\n- plotting shapes: `\"circle\"`, `\"square\"`, `\"cross\"`, `\"diamond\"`, `\"triangle-up\"`, `\"triangle-down\"`, `\"triangle-right\"`, or `\"triangle-left\"`.\n- the line symbol `\"stroke\"`\n- centered directional shapes `\"arrow\"`, `\"wedge\"`, or `\"triangle\"`\n- a custom [SVG path string](https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths) (For correct sizing, custom shape paths should be defined within a square bounding box with coordinates ranging from -1 to 1 along both the x and y dimensions.)\n\n__Default value:__ `\"circle\"`",
"type": "string"
},
"size": {
"description": "Default size for marks.\n- For `point`/`circle`/`square`, this represents the pixel area of the marks. For example: in the case of circles, the radius is determined in part by the square root of the size value.\n- For `bar`, this represents the band size of the bar, in pixels.\n- For `text`, this represents the font size, in pixels.\n\n__Default value:__\n- `30` for point, circle, square marks; width/height's `step`\n- `2` for bar marks with discrete dimensions;\n- `5` for bar marks with continuous dimensions;\n- `11` for text marks.",
"minimum": 0,
"type": "number"
},
"stroke": {
"anyOf": [
{
"$ref": "#/definitions/Color"
},
{
"$ref": "#/definitions/Gradient"
},
{
"type": "null"
}
],
"description": "Default Stroke Color. This has higher precedence than `config.color`.\n\n__Default value:__ (None)"
},
"strokeCap": {
"$ref": "#/definitions/StrokeCap",
"description": "The stroke cap for line ending style. One of `\"butt\"`, `\"round\"`, or `\"square\"`.\n\n__Default value:__ `\"square\"`"
},
"strokeDash": {
"description": "An array of alternating stroke, space lengths for creating dashed or dotted lines.",
"items": {
"type": "number"
},
"type": "array"
},
"strokeDashOffset": {
"description": "The offset (in pixels) into which to begin drawing with the stroke dash array.",
"type": "number"
},
"strokeJoin": {
"$ref": "#/definitions/StrokeJoin",
"description": "The stroke line join method. One of `\"miter\"`, `\"round\"` or `\"bevel\"`.\n\n__Default value:__ `\"miter\"`"
},
"strokeMiterLimit": {
"description": "The miter limit at which to bevel a line join.",
"type": "number"
},
"strokeOpacity": {
"description": "The stroke opacity (value between [0,1]).\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
"strokeWidth": {
"description": "The stroke width, in pixels.",
"minimum": 0,
"type": "number"
},
"tension": {
"description": "Depending on the interpolation type, sets the tension parameter (for line and area marks).",
"type": "number"
},
"text": {
"$ref": "#/definitions/Text",
"description": "Placeholder text if the `text` channel is not specified"
},
"theta": {
"description": "Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating \"north\".",
"type": "number"
},
"timeUnitBand": {
"description": "Default relative band size for a time unit. If set to `1`, the bandwidth of the marks will be equal to the time unit band step.\nIf set to `0.5`, bandwidth of the marks will be half of the time unit band step.",
"type": "number"
},
"timeUnitBandPosition": {
"description": "Default relative band position for a time unit. If set to `0`, the marks will be positioned at the beginning of the time unit band step.\nIf set to `0.5`, the marks will be positioned in the middle of the time unit band step.",
"type": "number"
},
"tooltip": {
"anyOf": [
{
"$ref": "#/definitions/Value"
},
{
"$ref": "#/definitions/TooltipContent"
},
{
"type": "null"
}
],
"description": "The tooltip text string to show upon mouse hover or an object defining which fields should the tooltip be derived from.\n\n- If `tooltip` is `true` or `{\"content\": \"encoding\"}`, then all fields from `encoding` will be used.\n- If `tooltip` is `{\"content\": \"data\"}`, then all fields that appear in the highlighted data point will be used.\n- If set to `null` or `false`, then no tooltip will be used.\n\nSee the [`tooltip`](https://vega.github.io/vega-lite/docs/tooltip.html) documentation for a detailed discussion about tooltip in Vega-Lite.\n\n__Default value:__ `null`"
},
"width": {
"description": "Width of the marks.",
"type": "number"
},
"x": {
"anyOf": [
{
"type": "number"
},
{
"enum": [
"width"
],
"type": "string"
}
],
"description": "X coordinates of the marks, or width of horizontal `\"bar\"` and `\"area\"` without specified `x2` or `width`.\n\nThe `value` of this channel can be a number or a string `\"width\"` for the width of the plot."
},
"x2": {
"anyOf": [
{
"type": "number"
},
{
"enum": [
"width"
],
"type": "string"
}
],
"description": "X2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`.\n\nThe `value` of this channel can be a number or a string `\"width\"` for the width of the plot."
},
"y": {
"anyOf": [
{
"type": "number"
},
{
"enum": [
"height"
],
"type": "string"
}
],
"description": "Y coordinates of the marks, or height of vertical `\"bar\"` and `\"area\"` without specified `y2` or `height`.\n\nThe `value` of this channel can be a number or a string `\"height\"` for the height of the plot."
},
"y2": {
"anyOf": [
{
"type": "number"
},
{
"enum": [
"height"
],
"type": "string"
}
],
"description": "Y2 coordinates for ranged `\"area\"`, `\"bar\"`, `\"rect\"`, and `\"rule\"`.\n\nThe `value` of this channel can be a number or a string `\"height\"` for the height of the plot."
}
},
"type": "object"
},
"ArgmaxDef": {
"additionalProperties": false,
"properties": {
"argmax": {
"type": "string"
}
},
"required": [
"argmax"
],
"type": "object"
},
"ArgminDef": {
"additionalProperties": false,
"properties": {
"argmin": {
"type": "string"
}
},
"required": [
"argmin"
],
"type": "object"
},
"AutoSizeParams": {
"additionalProperties": false,
"properties": {
"contains": {
"description": "Determines how size calculation should be performed, one of `\"content\"` or `\"padding\"`. The default setting (`\"content\"`) interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the `\"padding\"` setting includes the padding within the view size calculations, such that the width and height settings indicate the **total** intended size of the view.\n\n__Default value__: `\"content\"`",
"enum": [
"content",
"padding"
],
"type": "string"
},
"resize": {
"description": "A boolean flag indicating if autosize layout should be re-calculated on every view update.\n\n__Default value__: `false`",
"type": "boolean"
},
"type": {
"$ref": "#/definitions/AutosizeType",
"description": "The sizing format type. One of `\"pad\"`, `\"fit\"`, `\"fit-x\"`, `\"fit-y\"`, or `\"none\"`. See the [autosize type](https://vega.github.io/vega-lite/docs/size.html#autosize) documentation for descriptions of each.\n\n__Default value__: `\"pad\"`"
}
},
"type": "object"
},
"AutosizeType": {
"enum": [
"pad",
"none",
"fit",
"fit-x",
"fit-y"
],
"type": "string"
},
"Axis": {
"additionalProperties": false,
"properties": {
"bandPosition": {
"description": "An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands.\n\n __Default value:__ `0.5`",
"type": "number"
},
"domain": {
"description": "A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.\n\n__Default value:__ `true`",
"type": "boolean"
},
"domainColor": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Color"
}
],
"description": "Color of axis domain line.\n\n__Default value:__ `\"gray\"`."
},
"domainDash": {
"description": "An array of alternating [stroke, space] lengths for dashed domain lines.",
"items": {
"type": "number"
},
"type": "array"
},
"domainDashOffset": {
"description": "The pixel offset at which to start drawing with the domain dash array.",
"type": "number"
},
"domainOpacity": {
"description": "Opacity of the axis domain line.",
"type": "number"
},
"domainWidth": {
"description": "Stroke width of axis domain line\n\n__Default value:__ `1`",
"type": "number"
},
"format": {
"description": "The text formatting pattern for labels of guides (axes, legends, headers) and text marks.\n\n- If the format type is `\"number\"` (e.g., for quantitative fields), this is D3's [number format pattern](https://github.com/d3/d3-format#locale_format).\n- If the format type is `\"time\"` (e.g., for temporal fields), this is D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format).\n\nSee the [format documentation](https://vega.github.io/vega-lite/docs/format.html) for more examples.\n\n__Default value:__ Derived from [numberFormat](https://vega.github.io/vega-lite/docs/config.html#format) config for number format and from [timeFormat](https://vega.github.io/vega-lite/docs/config.html#format) config for time format.",
"type": "string"
},
"formatType": {
"description": "The format type for labels (`\"number\"` or `\"time\"`).\n\n__Default value:__\n- `\"time\"` for temporal fields and ordinal and nomimal fields with `timeUnit`.\n- `\"number\"` for quantitative fields as well as ordinal and nomimal fields without `timeUnit`.",
"enum": [
"number",
"time"
],
"type": "string"
},
"grid": {
"description": "A boolean flag indicating if grid lines should be included as part of the axis\n\n__Default value:__ `true` for [continuous scales](https://vega.github.io/vega-lite/docs/scale.html#continuous) that are not binned; otherwise, `false`.",
"type": "boolean"
},
"gridColor": {
"anyOf": [
{
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Color"
}
],
"description": "Color of gridlines.\n\n__Default value:__ `\"lightGray\"`."
},
{
"$ref": "#/definitions/ConditionalAxisColor"
}
]
},
"gridDash": {
"anyOf": [
{
"description": "An array of alternating [stroke, space] lengths for dashed grid lines.",
"items": {
"type": "number"
},
"type": "array"
},
{
"$ref": "#/definitions/ConditionalAxisNumberArray"
}
]
},
"gridDashOffset": {
"anyOf": [
{
"description": "The pixel offset at which to start drawing with the grid dash array.",
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"gridOpacity": {
"anyOf": [
{
"description": "The stroke opacity of grid (value between [0,1])\n\n__Default value:__ `1`",
"maximum": 1,
"minimum": 0,
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"gridWidth": {
"anyOf": [
{
"description": "The grid width, in pixels.\n\n__Default value:__ `1`",
"minimum": 0,
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"labelAlign": {
"anyOf": [
{
"$ref": "#/definitions/Align",
"description": "Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation."
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"labelAngle": {
"description": "The rotation angle of the axis labels.\n\n__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.",
"maximum": 360,
"minimum": -360,
"type": "number"
},
"labelBaseline": {
"anyOf": [
{
"$ref": "#/definitions/TextBaseline",
"description": "Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. Can be `\"top\"`, `\"middle\"`, `\"bottom\"`, or `\"alphabetic\"`."
},
{
"$ref": "#/definitions/ConditionalAxisLabelBaseline"
}
]
},
"labelBound": {
"description": "Indicates if labels should be hidden if they exceed the axis range. If `false` (the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.\n\n__Default value:__ `false`.",
"type": [
"number",
"boolean"
]
},
"labelColor": {
"anyOf": [
{
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Color"
}
],
"description": "The color of the tick label, can be in hex color code or regular color name."
},
{
"$ref": "#/definitions/ConditionalAxisColor"
}
]
},
"labelExpr": {
"description": "[Vega expression](https://vega.github.io/vega/docs/expressions/) for customizing labels.\n\n__Note:__ The label text and value can be assessed via the `label` and `value` properties of the axis's backing `datum` object.",
"type": "string"
},
"labelFlush": {
"description": "Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.",
"type": [
"boolean",
"number"
]
},
"labelFlushOffset": {
"description": "Indicates the number of pixels by which to offset flush-adjusted labels. For example, a value of `2` will push flush-adjusted labels 2 pixels outward from the center of the axis. Offsets can help the labels better visually group with corresponding axis ticks.\n\n__Default value:__ `0`.",
"type": "number"
},
"labelFont": {
"anyOf": [
{
"description": "The font of the tick label.",
"type": "string"
},
{
"$ref": "#/definitions/ConditionalAxisString"
}
]
},
"labelFontSize": {
"anyOf": [
{
"description": "The font size of the label, in pixels.",
"minimum": 0,
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"labelFontStyle": {
"anyOf": [
{
"$ref": "#/definitions/FontStyle",
"description": "Font style of the title."
},
{
"$ref": "#/definitions/ConditionalAxisLabelFontStyle"
}
]
},
"labelFontWeight": {
"anyOf": [
{
"$ref": "#/definitions/FontWeight",
"description": "Font weight of axis tick labels."
},
{
"$ref": "#/definitions/ConditionalAxisLabelFontWeight"
}
]
},
"labelLimit": {
"description": "Maximum allowed pixel width of axis tick labels.\n\n__Default value:__ `180`",
"type": "number"
},
"labelOpacity": {
"anyOf": [
{
"description": "The opacity of the labels.",
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"labelOverlap": {
"$ref": "#/definitions/LabelOverlap",
"description": "The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `\"parity\"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `\"greedy\"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).\n\n__Default value:__ `true` for non-nominal fields with non-log scales; `\"greedy\"` for log scales; otherwise `false`."
},
"labelPadding": {
"description": "The padding, in pixels, between axis and text labels.\n\n__Default value:__ `2`",
"type": "number"
},
"labelSeparation": {
"description": "The minimum separation that must be between label bounding boxes for them to be considered non-overlapping (default `0`). This property is ignored if *labelOverlap* resolution is not enabled.",
"type": "number"
},
"labels": {
"description": "A boolean flag indicating if labels should be included as part of the axis.\n\n__Default value:__ `true`.",
"type": "boolean"
},
"maxExtent": {
"description": "The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.\n\n__Default value:__ `undefined`.",
"type": "number"
},
"minExtent": {
"description": "The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.\n\n__Default value:__ `30` for y-axis; `undefined` for x-axis.",
"type": "number"
},
"offset": {
"description": "The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.\n\n__Default value:__ derived from the [axis config](https://vega.github.io/vega-lite/docs/config.html#facet-scale-config)'s `offset` (`0` by default)",
"type": "number"
},
"orient": {
"$ref": "#/definitions/AxisOrient",
"description": "The orientation of the axis. One of `\"top\"`, `\"bottom\"`, `\"left\"` or `\"right\"`. The orientation can be used to further specialize the axis type (e.g., a y-axis oriented towards the right edge of the chart).\n\n__Default value:__ `\"bottom\"` for x-axes and `\"left\"` for y-axes."
},
"position": {
"description": "The anchor position of the axis in pixels. For x-axes with top or bottom orientation, this sets the axis group x coordinate. For y-axes with left or right orientation, this sets the axis group y coordinate.\n\n__Default value__: `0`",
"type": "number"
},
"tickBand": {
"description": "For band scales, indicates if ticks and grid lines should be placed at the center of a band (default) or at the band extents to indicate intervals.",
"enum": [
"center",
"extent"
],
"type": "string"
},
"tickColor": {
"anyOf": [
{
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Color"
}
],
"description": "The color of the axis's tick.\n\n__Default value:__ `\"gray\"`"
},
{
"$ref": "#/definitions/ConditionalAxisColor"
}
]
},
"tickCount": {
"description": "A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are \"nice\" (multiples of 2, 5, 10) and lie within the underlying scale's range.\n\n__Default value__: Determine using a formula `ceil(width/40)` for x and `ceil(height/40)` for y.",
"minimum": 0,
"type": "number"
},
"tickDash": {
"anyOf": [
{
"description": "An array of alternating [stroke, space] lengths for dashed tick mark lines.",
"items": {
"type": "number"
},
"type": "array"
},
{
"$ref": "#/definitions/ConditionalAxisNumberArray"
}
]
},
"tickDashOffset": {
"anyOf": [
{
"description": "The pixel offset at which to start drawing with the tick mark dash array.",
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"tickExtra": {
"description": "Boolean flag indicating if an extra axis tick should be added for the initial position of the axis. This flag is useful for styling axes for `band` scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with `\"bandPosition\": 1` and an axis `\"padding\"` value of `0`.",
"type": "boolean"
},
"tickMinStep": {
"description": "The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of `1` indicates that ticks should not be less than 1 unit apart. If `tickMinStep` is specified, the `tickCount` value will be adjusted, if necessary, to enforce the minimum step value.\n\n__Default value__: `undefined`",
"type": "number"
},
"tickOffset": {
"description": "Position offset in pixels to apply to ticks, labels, and gridlines.",
"type": "number"
},
"tickOpacity": {
"anyOf": [
{
"description": "Opacity of the ticks.",
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"tickRound": {
"description": "Boolean flag indicating if pixel position values should be rounded to the nearest integer.\n\n__Default value:__ `true`",
"type": "boolean"
},
"tickSize": {
"description": "The size in pixels of axis ticks.\n\n__Default value:__ `5`",
"minimum": 0,
"type": "number"
},
"tickWidth": {
"anyOf": [
{
"description": "The width, in pixels, of ticks.\n\n__Default value:__ `1`",
"minimum": 0,
"type": "number"
},
{
"$ref": "#/definitions/ConditionalAxisNumber"
}
]
},
"ticks": {
"description": "Boolean value that determines whether the axis should include ticks.\n\n__Default value:__ `true`",
"type": "boolean"
},
"title": {
"anyOf": [
{
"$ref": "#/definitions/Text"
},
{
"type": "null"
}
],
"description": "A title for the field. If `null`, the title will be removed.\n\n__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as part of the title (e.g., `\"Sum of Profit\"`). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g., `\"Profit (binned)\"`, `\"Transaction Date (year-month)\"`). Otherwise, the title is simply the field name.\n\n__Notes__:\n\n1) You can customize the default field title format by providing the [`fieldTitle`](https://vega.github.io/vega-lite/docs/config.html#top-level-config) property in the [config](https://vega.github.io/vega-lite/docs/config.html) or [`fieldTitle` function via the `compile` function's options](https://vega.github.io/vega-lite/docs/compile.html#field-title).\n\n2) If both field definition's `title` and axis, header, or legend `title` are defined, axis/header/legend title will be used."
},
"titleAlign": {
"$ref": "#/definitions/Align",
"description": "Horizontal text alignment of axis titles."
},
"titleAnchor": {
"$ref": "#/definitions/TitleAnchor",
"description": "Text anchor position for placing axis titles."
},
"titleAngle": {
"description": "Angle in degrees of axis titles.",
"type": "number"
},
"titleBaseline": {
"$ref": "#/definitions/TextBaseline",
"description": "Vertical text baseline for axis titles."
},
"titleColor": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Color"
}
],
"description": "Color of the title, can be in hex color code or regular color name."
},
"titleFont": {
"description": "Font of the title. (e.g., `\"Helvetica Neue\"`).",
"type": "string"
},
"titleFontSize": {
"description": "Font size of the title.",
"minimum": 0,
"type": "number"
},
"titleFontStyle": {
"$ref": "#/definitions/FontStyle",
"description": "Font style of the title."
},
"titleFontWeight": {
"$ref": "#/definitions/FontWeight",
"description": "Font weight of the title.\nThis can be either a string (e.g `\"bold\"`, `\"normal\"`) or a number (`100`, `200`, `300`, ..., `900` where `\"normal\"` = `400` and `\"bold\"` = `700`)."
},
"titleLimit": {
"description": "Maximum allowed pixel width of axis titles.",
"minimum": 0,
"type": "number"
},
"titleLineHeight": {
"description": "Line height in pixels for multi-line title text.",
"type": "number"
},
"titleOpacity": {
"description": "Opacity of the axis title.",
"type": "number"
},
"titlePadding": {
"description": "The padding, in pixels, between title and axis.",
"type": "number"
},
"titleX": {