Type TopLevelExtendedSpec
File match *.vl *.vl.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/vega-lite-json/latest.json
Source https://www.schemastore.org/vega-lite.json

Validate with Lintel

npx @lintel/lintel check
Type: TopLevelExtendedSpec

Definitions

Aggregate AggregateOp
AggregateOp string
AggregateTransform object
aggregate AggregatedFieldDef[] required

Array of objects that define fields to aggregate.

groupby string[]

The data fields to group by. If not specified, a single group containing all data objects will be used.

AggregatedFieldDef object
as string required

The output field names to use for each aggregated field.

field string required

The data field for which to compute aggregate function.

op string required
Values: "argmax" "argmin" "average" "count" "distinct" "max" "mean" "median" "min" "missing" "q1" "q3" "ci0" "ci1" "stdev" "stdevp" "sum" "valid" "values" "variance" "variancep"
Anchor string
AnyMark Mark | MarkDef
AutoSizeParams object
contains string

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.

Default value: "content"

Values: "content" "padding"
resize boolean

A boolean flag indicating if autosize layout should be re-calculated on every view update.

Default value: false

type string
Values: "pad" "fit" "none"
AutosizeType string
Axis object
domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

See the format documentation for more information.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

offset number

The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.

Default value: derived from the axis config's offset (0 by default)

orient string
Values: "top" "right" "left" "bottom"
position number

The anchor position of the axis in pixels. For x-axis with top or bottom orientation, this sets the axis group x coordinate. For y-axis with left or right orientation, this sets the axis group y coordinate.

Default value: 0

tickCount number

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.

tickSize number

The size in pixels of axis ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

title string | null

A title for the field. If null, the title will be removed.

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 a part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Note: You can customize the default field title format by providing the [fieldTitle property in the config or fieldTitle function via the compile function's options.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

values number[] | DateTime[]

Explicitly set the visible axis tick values.

zindex number

A non-positive integer indicating z-index of the axis. If zindex is 0, axes should be drawn behind all chart elements. To put them in front, use "zindex = 1".

Default value: 1 (in front of the marks) for actual axis and 0 (behind the marks) for grids.

min=0
AxisConfig object
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

AxisConfigMixins object
axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

AxisOrient string
AxisResolveMap object
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
BarConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

BaseBin object
base number

The number base to use for automatic bin determination (default is base 10).

Default value: 10

divide number[]

Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.

Default value: [5, 2]

minItems=1
maxbins number

Maximum number of bins.

Default value: 6 for row, column and shape channels; 10 for other channels

min=2
minstep number

A minimum allowable step size (particularly useful for integer values).

nice boolean

If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.

step number

An exact step size to use between bins.

Note: If provided, options such as maxbins will be ignored.

steps number[]

An array of allowable step sizes to choose from.

minItems=1
BaseSelectionDef object
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

on
resolve string
Values: "global" "union" "intersect"
BaseSpec object
description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

BinParams object

Binning properties or boolean flag for determining whether to bin data or not.

base number

The number base to use for automatic bin determination (default is base 10).

Default value: 10

divide number[]

Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.

Default value: [5, 2]

minItems=1
extent number[]

A two-element ([min, max]) array indicating the range of desired bin values.

minItems=2maxItems=2
maxbins number

Maximum number of bins.

Default value: 6 for row, column and shape channels; 10 for other channels

min=2
minstep number

A minimum allowable step size (particularly useful for integer values).

nice boolean

If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.

step number

An exact step size to use between bins.

Note: If provided, options such as maxbins will be ignored.

steps number[]

An array of allowable step sizes to choose from.

minItems=1
BinTransform object
as string required

The output fields at which to write the start and end bin values.

bin boolean | BinParams required

An object indicating bin properties, or simply true for using default bin parameters.

field string required

The data field to bin.

BoxPlotConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

Size of the box and mid tick of a box plot

stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

BoxPlotConfigMixins object
box object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

Size of the box and mid tick of a box plot

stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

boxMid object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

boxWhisker object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

BrushConfig object
fill string

The fill color of the interval mark.

Default value: #333333

fillOpacity number

The fill opacity of the interval mark (a value between 0 and 1).

Default value: 0.125

stroke string

The stroke color of the interval mark.

Default value: #ffffff

strokeDash number[]

An array of alternating stroke and space lengths, for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) with which to begin drawing the stroke dash array.

strokeOpacity number

The stroke opacity of the interval mark (a value between 0 and 1).

strokeWidth number

The stroke width of the interval mark.

CalculateTransform object
as string required

The field for storing the computed formula value.

calculate string required

A string containing a Vega Expression. Use the variable datum to refer to the current data object.

CompositeMarkConfigMixins object
box object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

Size of the box and mid tick of a box plot

stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

boxMid object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

boxWhisker object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

CompositeUnitSpec object
encoding object required
12 nested properties

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

mark Mark | MarkDef required
description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

A key-value mapping between selection names and definitions.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

Conditional<MarkPropFieldDef> object
selection SelectionNot | SelectionAnd | SelectionOr | string required
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

legend Legend | null

An object defining properties of the legend. If null, the legend for the encoding channel will be removed.

Default value: If undefined, default legend properties are applied.

scale object
15 nested properties
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

sort SortOrder | SortField | null

Sort order for the encoded field. Supported sort values include "ascending", "descending" and null (no sorting). For fields with discrete domains, sort can also be a sort field definition object.

Default value: "ascending"

Conditional<TextFieldDef> object
selection SelectionNot | SelectionAnd | SelectionOr | string required
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

format string

The formatting pattern for a text field. If not defined, this will be determined automatically.

Conditional<ValueDef> object
selection SelectionNot | SelectionAnd | SelectionOr | string required
value number | string | boolean required

A constant value in visual domain (e.g., "red" / "#0099ff" for color, values between 0 to 1 for opacity).

Config object
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
9 nested properties
bind string

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

Values: "scales"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

mark object
on
resolve string
Values: "global" "union" "intersect"
translate string | boolean

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

zoom string | boolean

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

multi object
7 nested properties
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
toggle string | boolean

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

See the toggle transform documentation for more information.

single object
7 nested properties
bind VgBinding | object

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See the bind transform documentation for more information.

empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

CsvDataFormat object
parse string | object

If set to auto (the default), perform automatic type inference to determine the desired data types. Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of "number", "boolean" or "date"). For example, "parse": {"modified_on": "date"} parses the modified_on field in each input record a Date value.

For "date", we parse data based using Javascript's Date.parse(). For Specific date formats can be provided (e.g., {foo: 'date:"%m%d%Y"'}), using the d3-time-format syntax. UTC date format parsing is supported similarly (e.g., {foo: 'utc:"%m%d%Y"'}). See more about UTC time

type string

Type of input data: "json", "csv", "tsv". The default format type is determined by the extension of the file URL. If no extension is detected, "json" will be used by default.

Values: "csv" "tsv"
Data UrlData | InlineData | NamedData
DataFormat CsvDataFormat | JsonDataFormat | TopoDataFormat
DataFormatBase object
parse string | object

If set to auto (the default), perform automatic type inference to determine the desired data types. Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of "number", "boolean" or "date"). For example, "parse": {"modified_on": "date"} parses the modified_on field in each input record a Date value.

For "date", we parse data based using Javascript's Date.parse(). For Specific date formats can be provided (e.g., {foo: 'date:"%m%d%Y"'}), using the d3-time-format syntax. UTC date format parsing is supported similarly (e.g., {foo: 'utc:"%m%d%Y"'}). See more about UTC time

type string
Values: "json" "csv" "tsv" "topojson"
DataFormatType string
DateTime object

Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. day cannot be combined with other date. We accept string for month and day names.

date number

Integer value representing the date from 1-31.

min=1max=31
day Day | string

Value representing the day of a week. This can be one of: (1) integer value -- 1 represents Monday; (2) case-insensitive day name (e.g., "Monday"); (3) case-insensitive, 3-character short day name (e.g., "Mon").
Warning: A DateTime definition object with day** should not be combined with year, quarter, month, or date.

hours number

Integer value representing the hour of a day from 0-23.

min=0max=23
milliseconds number

Integer value representing the millisecond segment of time.

min=0max=999
minutes number

Integer value representing the minute segment of time from 0-59.

min=0max=59
month Month | string

One of: (1) integer value representing the month from 1-12. 1 represents January; (2) case-insensitive month name (e.g., "January"); (3) case-insensitive, 3-character short month name (e.g., "Jan").

quarter number

Integer value representing the quarter of the year (from 1-4).

min=1max=4
seconds number

Integer value representing the second segment (0-59) of a time value

min=0max=59
utc boolean

A boolean flag indicating if date time is in utc time. If false, the date time is in local time

year number

Integer value representing the year.

Day number
Encoding object

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

EncodingWithFacet object

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

2 nested properties
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

sort string | string | null
detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

2 nested properties
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

sort string | string | null

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

EqualFilter object
equal string | number | boolean | DateTime required

The value that the field should be equal to.

field string required

Field to be filtered.

FacetFieldDef object
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

2 nested properties
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

sort string | string | null
FacetMapping object
column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

2 nested properties
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

sort string | string | null
row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

2 nested properties
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

sort string | string | null
FacetedUnitSpec object
encoding object required
14 nested properties

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

mark Mark | MarkDef required
description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

A key-value mapping between selection names and definitions.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

FieldDef object

Definition object for a data field, its type and transformation of an encoding channel.

type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

FieldDefBase object
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

MarkPropFieldDefWithCondition object

A FieldDef with Condition { condition: {value: ...}, field: ..., ... }

type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

One or more value definition(s) with a selection predicate.

Note: A field definition's condition property can only contain value definitions since Vega-Lite only allows at mostly one encoded field per encoding channel.

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

legend Legend | null

An object defining properties of the legend. If null, the legend for the encoding channel will be removed.

Default value: If undefined, default legend properties are applied.

scale object
15 nested properties
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

sort SortOrder | SortField | null

Sort order for the encoded field. Supported sort values include "ascending", "descending" and null (no sorting). For fields with discrete domains, sort can also be a sort field definition object.

Default value: "ascending"

TextFieldDefWithCondition object

A FieldDef with Condition { condition: {value: ...}, field: ..., ... }

type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

One or more value definition(s) with a selection predicate.

Note: A field definition's condition property can only contain value definitions since Vega-Lite only allows at mostly one encoded field per encoding channel.

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

format string

The formatting pattern for a text field. If not defined, this will be determined automatically.

Filter EqualFilter | RangeFilter | OneOfFilter | SelectionFilter | string
FilterTransform object
filter NotFilter | AndFilter | OrFilter | Filter required
FontStyle string
FontWeight string
FontWeightNumber number
FacetSpec object
facet object required
2 nested properties
column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
spec LayerSpec | CompositeUnitSpec required

A specification of the view that gets faceted.

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

HConcatSpec object
hconcat Spec[] required

A list of views that should be concatenated and put into a row.

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

LayerSpec object
layer LayerSpec | CompositeUnitSpec[] required

Layer or single view specifications to be layered.

Note: Specifications inside layer cannot use row and column channels as layering facet specifications is not allowed.

description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

RepeatSpec object
repeat object required
2 nested properties
column string[]

Horizontal repeated views.

row string[]

Vertical repeated views.

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

Spec CompositeUnitSpec | LayerSpec | FacetSpec | RepeatSpec | VConcatSpec | HConcatSpec
CompositeUnitSpecAlias object
encoding object required
12 nested properties

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

mark Mark | MarkDef required
description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

A key-value mapping between selection names and definitions.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

FacetedCompositeUnitSpecAlias object
encoding object required
14 nested properties

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

mark Mark | MarkDef required
description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

A key-value mapping between selection names and definitions.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

VConcatSpec object
vconcat Spec[] required

A list of views that should be concatenated and put into a column.

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

Guide object
format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

See the format documentation for more information.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string | null

A title for the field. If null, the title will be removed.

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 a part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Note: You can customize the default field title format by providing the [fieldTitle property in the config or fieldTitle function via the compile function's options.

Header object

Headers of row / column channels for faceted plots.

format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

title string

A title for the axis. Shows field name and its function by default.

Default value: derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

HorizontalAlign string
InlineData object
values number[] | string[] | boolean[] | object[] | string | object required

The full data set, included inline. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a data property. Strings are parsed according to the specified format type.

Interpolate string
InterpolateParams object
type string required
Values: "rgb" "cubehelix" "cubehelix-long"
gamma number
IntervalSelection object
type string required
Values: "interval"
bind string

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

Values: "scales"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

mark object
7 nested properties
fill string

The fill color of the interval mark.

Default value: #333333

fillOpacity number

The fill opacity of the interval mark (a value between 0 and 1).

Default value: 0.125

stroke string

The stroke color of the interval mark.

Default value: #ffffff

strokeDash number[]

An array of alternating stroke and space lengths, for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) with which to begin drawing the stroke dash array.

strokeOpacity number

The stroke opacity of the interval mark (a value between 0 and 1).

strokeWidth number

The stroke width of the interval mark.

on
resolve string
Values: "global" "union" "intersect"
translate string | boolean

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

zoom string | boolean

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

IntervalSelectionConfig object
bind string

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

Values: "scales"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

mark object
7 nested properties
fill string

The fill color of the interval mark.

Default value: #333333

fillOpacity number

The fill opacity of the interval mark (a value between 0 and 1).

Default value: 0.125

stroke string

The stroke color of the interval mark.

Default value: #ffffff

strokeDash number[]

An array of alternating stroke and space lengths, for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) with which to begin drawing the stroke dash array.

strokeOpacity number

The stroke opacity of the interval mark (a value between 0 and 1).

strokeWidth number

The stroke width of the interval mark.

on
resolve string
Values: "global" "union" "intersect"
translate string | boolean

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

zoom string | boolean

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

JsonDataFormat object
parse string | object

If set to auto (the default), perform automatic type inference to determine the desired data types. Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of "number", "boolean" or "date"). For example, "parse": {"modified_on": "date"} parses the modified_on field in each input record a Date value.

For "date", we parse data based using Javascript's Date.parse(). For Specific date formats can be provided (e.g., {foo: 'date:"%m%d%Y"'}), using the d3-time-format syntax. UTC date format parsing is supported similarly (e.g., {foo: 'utc:"%m%d%Y"'}). See more about UTC time

property string

The JSON property containing the desired data. This parameter can be used when the loaded JSON file may have surrounding structure or meta-data. For example "property": "values.features" is equivalent to retrieving json.values.features from the loaded JSON object.

type string

Type of input data: "json", "csv", "tsv". The default format type is determined by the extension of the file URL. If no extension is detected, "json" will be used by default.

Values: "json"
LayoutSizeMixins object
height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

Legend object

Properties of a legend or boolean flag for determining whether to show it.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

format string

The formatting pattern for labels. This is D3's number format pattern for quantitative fields and D3's time format pattern for time field.

See the format documentation for more information.

Default value: derived from numberFormat config for quantitative fields and from timeFormat config for temporal fields.

offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

tickCount number

The desired number of tick values for quantitative legends.

title string | null

A title for the field. If null, the title will be removed.

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 a part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Note: You can customize the default field title format by providing the [fieldTitle property in the config or fieldTitle function via the compile function's options.

type string

The type of the legend. Use "symbol" to create a discrete legend and "gradient" for a continuous color gradient.

Default value: "gradient" for non-binned quantitative fields and temporal fields; "symbol" otherwise.

Values: "symbol" "gradient"
values number[] | string[] | DateTime[]

Explicitly set the visible legend values.

zindex number

A non-positive integer indicating z-index of the legend. If zindex is 0, legend should be drawn behind all chart elements. To put them in front, use zindex = 1.

min=0
LegendConfig object
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

LegendOrient string
LegendResolveMap object
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
LocalMultiTimeUnit string
LocalSingleTimeUnit string
AndFilter object
and FilterOperand[] required
SelectionAnd object
and SelectionOperand[] required
NotFilter object
not NotFilter | AndFilter | OrFilter | Filter required
SelectionNot object
not SelectionNot | SelectionAnd | SelectionOr | string required
FilterOperand NotFilter | AndFilter | OrFilter | Filter
SelectionOperand SelectionNot | SelectionAnd | SelectionOr | string
OrFilter object
or FilterOperand[] required
SelectionOr object
or SelectionOperand[] required
LookupData object
data UrlData | InlineData | NamedData required
key string required

Key in data to lookup.

fields string[]

Fields in foreign data to lookup. If not specified, the entire object is queried.

LookupTransform object
from object required
3 nested properties
data UrlData | InlineData | NamedData required
key string required

Key in data to lookup.

fields string[]

Fields in foreign data to lookup. If not specified, the entire object is queried.

lookup string required

Key in primary data source.

as string | string[]

The field or fields for storing the computed formula value. If from.fields is specified, the transform will use the same names for as. If from.fields is not specified, as has to be a string and we put the whole object into the data under the specified name.

default string

The default value to use if lookup fails.

Default value: null

Mark string

All types of primitive marks.

MarkConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

MarkConfigMixins object
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
MarkDef object
type string required

All types of primitive marks.

Values: "area" "bar" "line" "point" "text" "tick" "rect" "rule" "circle" "square"
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
clip boolean

Whether a mark be clipped to the enclosing group's width and height.

color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
style string | string[]

A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the style configuration. If style is an array, later styles will override earlier styles. Any mark properties explicitly defined within the encoding will override a style default.

Default value: The mark's name. For example, a bar mark will have style "bar" by default. Note: Any specified style will augment the default style. For example, a bar mark with "style": "foo" will receive from config.style.bar and config.style.foo (the specified style "foo" has higher precedence).

tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

MarkPropFieldDef object

Field definition of a mark property, which can contain a legend.

type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

legend Legend | null

An object defining properties of the legend. If null, the legend for the encoding channel will be removed.

Default value: If undefined, default legend properties are applied.

scale object
15 nested properties
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

sort SortOrder | SortField | null

Sort order for the encoded field. Supported sort values include "ascending", "descending" and null (no sorting). For fields with discrete domains, sort can also be a sort field definition object.

Default value: "ascending"

Month number
MultiSelection object
type string required
Values: "multi"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
toggle string | boolean

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

See the toggle transform documentation for more information.

MultiSelectionConfig object
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
toggle string | boolean

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

See the toggle transform documentation for more information.

MultiTimeUnit LocalMultiTimeUnit | UtcMultiTimeUnit
NamedData object
name string required

Provide a placeholder name and bind data at runtime.

NiceTime string
OneOfFilter object
field string required

Field to be filtered

oneOf string[] | number[] | boolean[] | DateTime[] required

A set of values that the field's value should be a member of, for a data item included in the filtered data.

OrderFieldDef object
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

sort string | string | null
Orient string
Padding number | object
PositionFieldDef object
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
axis Axis | null

An object defining properties of axis's gridlines, ticks and labels. If null, the axis for the encoding channel will be removed.

Default value: If undefined, default axis properties are applied.

bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

scale object
15 nested properties
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

sort SortOrder | SortField | null

Sort order for the encoded field. Supported sort values include "ascending", "descending" and null (no sorting). For fields with discrete domains, sort can also be a sort field definition object.

Default value: "ascending"

stack StackOffset | null

Type of stacking offset if the field should be stacked. stack is only applicable for x and y channels with continuous domains. For example, stack of y can be used to customize stacking for a vertical bar chart.

stack can be one of the following values:

  • "zero": stacking with baseline offset at zero value of the scale (for creating typical stacked bar and area chart).
  • "normalize" - stacking with normalized domain (for creating normalized stacked bar and area charts.
    -"center" - stacking with center baseline (for streamgraph).
  • null - No-stacking. This will produce layered bar and area chart.

Default value: zero for plots with all of the following conditions are true: (1) the mark is bar or area; (2) the stacked measure channel (x or y) has a linear scale; (3) At least one of non-position channels mapped to an unaggregated field that is different from x and y. Otherwise, null by default.

RangeConfig Record<string, number | string[] | VgScheme | object>
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

RangeConfigValue number | string[] | VgScheme | object
RangeFilter object
field string required

Field to be filtered

range number | DateTime[] required

An array of inclusive minimum and maximum values for a field value of a data item to be included in the filtered data.

minItems=2maxItems=2
Repeat object
column string[]

Horizontal repeated views.

row string[]

Vertical repeated views.

RepeatRef object

Reference to a repeated value.

repeat string required
Values: "row" "column"
Resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
ResolveMode string
Scale object
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

ScaleConfig object
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

ScaleFieldDef object
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

scale object
15 nested properties
base number

The logarithm base of the log scale (default 10).

clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

Default value: derived from the scale config's clamp (true by default).

domain number[] | string[] | boolean[] | DateTime[] | string | SelectionDomain

Customized domain values.

For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Piecewise scales can be created by providing a domain with more than two entries. If the input field is aggregated, domain can also be a string value "unaggregated", indicating that the domain should include the raw data values prior to the aggregation.

For temporal fields, domain can be a two-element array minimum and maximum values, in the form of either timestamps or the DateTime definition objects.

For ordinal and nominal fields, domain can be an array that lists valid input values.

The selection property can be used to interactively determine the scale domain.

exponent number

The exponent of the pow scale.

The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long ('-long' variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

nice boolean | number | NiceTime | object

Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale's domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0].

For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the nice value can be a string indicating the desired time interval. Legal values are "millisecond", "second", "minute", "hour", "day", "week", "month", and "year". Alternatively, time and utc scales can accept an object-valued interval specifier of the form {"interval": "month", "step": 3}, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

Default value: true for unbinned quantitative fields; false otherwise.

padding number

For continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

For band scales, shortcut for setting paddingInner and paddingOuter to the same value.

For point scales, alias for paddingOuter.

Default value: For continuous scales, derived from the scale config's continuousPadding. For band and point scales, see paddingInner and paddingOuter.

min=0
paddingInner number

The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1].

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

Default value: derived from the scale config's bandPaddingInner.

min=0max=1
paddingOuter number

The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1].

Default value: derived from the scale config's bandPaddingOuter for band scales and pointPadding for point scales.

min=0max=1
range number[] | string[] | string

The range of the scale. One of:

Notes:

  1. For sequential, ordinal, and discretizing color scales, you can also specify a color scheme instead of range.

  2. Any directly specified range for x and y channels will be ignored. Range can be customized via the view's corresponding size (width and height) or via range steps and paddings properties for band and point scales.

rangeStep number | null

The distance between the starts of adjacent bands or points in band and point scales.

If rangeStep is null or if the view contains the scale's corresponding size (width for x scales and height for y scales), rangeStep will be automatically determined to fit the size of the view.

Default value: derived the scale config's textXRangeStep (90 by default) for x-scales of text marks and rangeStep (21 by default) for x-scales of other marks and y-scales.

Warning: If rangeStep is null and the cardinality of the scale's domain is higher than width or height, the rangeStep might become less than one pixel and the mark might not appear correctly.

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

Default value: false.

scheme string | SchemeParams

A string indicating a color scheme name (e.g., "category10" or "viridis") or a scheme parameter object.

Discrete color schemes may be used with discrete or discretizing scales. Continuous color schemes are intended for use with sequential scales.

For the full list of supported scheme, please refer to the Vega Scheme reference.

type string
Values: "linear" "bin-linear" "log" "pow" "sqrt" "time" "utc" "sequential" "ordinal" "bin-ordinal" "point" "band"
zero boolean

If true, ensures that a zero baseline value is included in the scale domain.

Default value: true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise.

Note: Log, time, and utc scales do not support zero.

sort SortOrder | SortField | null

Sort order for the encoded field. Supported sort values include "ascending", "descending" and null (no sorting). For fields with discrete domains, sort can also be a sort field definition object.

Default value: "ascending"

ScaleResolveMap object
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
ScaleType string
SchemeParams object
name string required

A color scheme name for sequential/ordinal scales (e.g., "category10" or "viridis").

For the full list of supported scheme, please refer to the Vega Scheme reference.

extent number[]

For sequential and diverging schemes only, determines the extent of the color range to use. For example [0.2, 1] will rescale the color scheme such that color values in the range [0, 0.2) are excluded from the scheme.

SelectionConfig object
interval object
9 nested properties
bind string

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

Values: "scales"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

mark object
7 nested properties
fill string

The fill color of the interval mark.

Default value: #333333

fillOpacity number

The fill opacity of the interval mark (a value between 0 and 1).

Default value: 0.125

stroke string

The stroke color of the interval mark.

Default value: #ffffff

strokeDash number[]

An array of alternating stroke and space lengths, for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) with which to begin drawing the stroke dash array.

strokeOpacity number

The stroke opacity of the interval mark (a value between 0 and 1).

strokeWidth number

The stroke width of the interval mark.

on
resolve string
Values: "global" "union" "intersect"
translate string | boolean

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

zoom string | boolean

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

multi object
7 nested properties
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
toggle string | boolean

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

See the toggle transform documentation for more information.

single object
7 nested properties
bind VgBinding | object

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See the bind transform documentation for more information.

empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
SelectionDef SingleSelection | MultiSelection | IntervalSelection
SelectionDomain object | object
SelectionFilter object
selection SelectionNot | SelectionAnd | SelectionOr | string required
SelectionResolution string
SingleDefChannel string
SingleSelection object
type string required
Values: "single"
bind VgBinding | object

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See the bind transform documentation for more information.

empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
SingleSelectionConfig object
bind VgBinding | object

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See the bind transform documentation for more information.

empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
SingleTimeUnit LocalSingleTimeUnit | UtcSingleTimeUnit
SortField object
op string required
Values: "argmax" "argmin" "average" "count" "distinct" "max" "mean" "median" "min" "missing" "q1" "q3" "ci0" "ci1" "stdev" "stdevp" "sum" "valid" "values" "variance" "variancep"
field string | RepeatRef

The data field to sort by.

Default value: If unspecified, defaults to the field specified in the outer data reference.

order string | string | null
SortOrder string | string | null
StackOffset string
StyleConfigIndex Record<string, object>
TextConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

TextFieldDef object
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

format string

The formatting pattern for a text field. If not defined, this will be determined automatically.

TickConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
TimeUnit SingleTimeUnit | MultiTimeUnit
TimeUnitTransform object
as string required

The output field to write the timeUnit value.

field string required

The data field to apply time unit.

timeUnit SingleTimeUnit | MultiTimeUnit required
TitleBase object
anchor string
Values: "start" "middle" "end"
offset number

The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.

orient string
Values: "top" "bottom" "left" "right"
style string | string[]

A mark style property to apply to the title text mark.

Default value: "group-title".

TitleOrient string
TitleParams object
text string required

The title text.

anchor string
Values: "start" "middle" "end"
offset number

The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.

orient string
Values: "top" "bottom" "left" "right"
style string | string[]

A mark style property to apply to the title text mark.

Default value: "group-title".

TopLevel<FacetedUnitSpec> object
encoding object required
14 nested properties

Color of the marks – either fill or stroke color based on mark type. By default, color represents fill color for "area", "bar", "tick", "text", "circle", and "square" / stroke color for "line" and "point".

Default value: If undefined, the default color depends on mark config's color property.

Note: See the scale documentation for more information about customizing color scheme.

column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
detail FieldDef | FieldDef[]

Additional levels of detail for grouping data in aggregate views and in line and area marks without mapping data to a specific visual channel.

Opacity of the marks – either can be a value or a range.

Default value: If undefined, the default opacity depends on mark config's opacity property.

Stack order for stacked marks or order of data points in line marks for connected scatter plots.

Note: In aggregate plots, order field should be aggregated to avoid creating additional aggregation grouping.

row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null

The symbol's shape (only for point marks). The supported values are "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or else a custom SVG path string. Default value: If undefined, the default shape depends on mark config's shape property.

Size of the mark.

  • For "point", "square" and "circle", – the symbol size, or pixel area of the mark.
  • For "bar" and "tick" – the bar and tick's size.
  • For "text" – the text's font size.
  • Size is currently unsupported for "line", "area", and "rect".

The tooltip text to show upon mouse hover.

X coordinates of the marks, or width of horizontal "bar" and "area".

X2 coordinates for ranged "area", "bar", "rect", and "rule".

Y coordinates of the marks, or height of vertical "bar" and "area".

Y2 coordinates for ranged "area", "bar", "rect", and "rule".

mark Mark | MarkDef required
$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

padding number | object
min=0

A key-value mapping between selection names and definitions.

title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

TopLevel<FacetSpec> object
facet object required
2 nested properties
column object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
row object
7 nested properties
type string required

Constants and utilities for data type
Data type based on level of measurement

Values: "quantitative" "ordinal" "temporal" "nominal"
aggregate AggregateOp
bin boolean | BinParams

A flag for binning a quantitative field, or an object defining binning parameters. If true, default binning parameters will be applied.

Default value: false

field string | RepeatRef

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

Note: field is not required if aggregate is count.

header object

Headers of row / column channels for faceted plots.

sort string | string | null
spec LayerSpec | CompositeUnitSpec required

A specification of the view that gets faceted.

$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

padding number | object
min=0
resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

TopLevel<HConcatSpec> object
hconcat Spec[] required

A list of views that should be concatenated and put into a row.

$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

padding number | object
min=0
resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

TopLevel<LayerSpec> object
layer LayerSpec | CompositeUnitSpec[] required

Layer or single view specifications to be layered.

Note: Specifications inside layer cannot use row and column channels as layering facet specifications is not allowed.

$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

height number

The height of a visualization.

Default value:

Note: For plots with row and column channels, this represents the height of a single view.

See also: The documentation for width and height contains more examples.

name string

Name of the visualization for later reference.

padding number | object
min=0
resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

width number

The width of a visualization.

Default value: This will be determined by the following rules:

Note: For plots with row and column channels, this represents the width of a single view.

See also: The documentation for width and height contains more examples.

TopLevel<RepeatSpec> object
repeat object required
2 nested properties
column string[]

Horizontal repeated views.

row string[]

Vertical repeated views.

$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

padding number | object
min=0
resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

TopLevel<VConcatSpec> object
vconcat Spec[] required

A list of views that should be concatenated and put into a column.

$schema string

URL to JSON schema for a Vega-Lite specification. Unless you have a reason to change this, use <https://vega.github.io/schema/vega-lite/v2.json>. Setting the $schema property allows automatic validation and autocomplete in editors that support JSON schema.

format=uri

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

config object
35 nested properties
area object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

axis object
39 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBand object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisBottom object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisLeft object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisRight object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisTop object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisX object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

axisY object
38 nested properties
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

bar object
31 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
binSpacing number

Offset between bar for binned field. Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

Default value: 1

min=0
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

continuousBandSize number

The default size of the bars on continuous scales.

Default value: 5

min=0
discreteBandSize number

The size of the bars. If unspecified, the default size is bandSize-1, which provides 1 pixel offset between bars.

min=0
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

circle object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
legend object
36 nested properties
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

line object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

mark object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

padding number | object
min=0
point object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

6 nested properties
category string[] | VgScheme

Default range for nominal (categorical) fields.

diverging string[] | VgScheme

Default range for diverging quantitative fields.

heatmap string[] | VgScheme

Default range for quantitative heatmaps.

ordinal string[] | VgScheme

Default range for ordinal fields.

ramp string[] | VgScheme

Default range for quantitative and temporal fields.

symbol string[]

Default range palette for the shape channel.

rect object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

rule object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
multi object
single object
square object
28 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

stack string
Values: "zero" "center" "normalize"
style Record<string, object>
text object
29 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

tick object
30 nested properties
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
bandSize number

The width of the ticks.

Default value: 2/3 of rangeStep.

min=0
baseline string
Values: "top" "middle" "bottom"
color string

Default color. Note that fill and stroke have higher precedence than color and will override color.

Default value: â–  "#4682b4"

Note: This property cannot be used in a style config.

dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
filled boolean

Whether the mark's color should be used as fill color instead of stroke color.

Default value: true for all marks except point and false for point.

Applicable for: bar, point, circle, square, and area marks.

Note: This property cannot be used in a style config.

font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

thickness number

Thickness of the tick mark.

Default value: 1

min=0
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

title object
10 nested properties
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

description string

Description of this mark for commenting purpose.

name string

Name of the visualization for later reference.

padding number | object
min=0
resolve object

Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from scale, axis, and legend to a mapping from channels to resolutions.

3 nested properties
axis object
2 nested properties
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
legend object
4 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
scale object
6 nested properties
color string
Values: "independent" "shared"
opacity string
Values: "independent" "shared"
shape string
Values: "independent" "shared"
size string
Values: "independent" "shared"
x string
Values: "independent" "shared"
y string
Values: "independent" "shared"
title string | TitleParams

Title for the plot.

transform Transform[]

An array of data transformations such as filter and new field calculation.

TopLevelExtendedSpec TopLevel%3CFacetedUnitSpec%3E | TopLevel%3CLayerSpec%3E | TopLevel%3CFacetSpec%3E | TopLevel%3CRepeatSpec%3E | TopLevel%3CVConcatSpec%3E | TopLevel%3CHConcatSpec%3E
TopLevelProperties object

Sets how the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing. "fit" is only supported for single and layered views that don't use rangeStep.

Default value: pad

background string

CSS color property to use as the background of visualization.

Default value: none (transparent)

padding number | object
min=0
TopoDataFormat object
feature string

The name of the TopoJSON object set to convert to a GeoJSON feature collection. For example, in a map of the world, there may be an object set named "countries". Using the feature property, we can extract this set and generate a GeoJSON feature object for each country.

mesh string

The name of the TopoJSON object set to convert to mesh. Similar to the feature option, mesh extracts a named TopoJSON object set. Unlike the feature option, the corresponding geo data is returned as a single, unified mesh instance, not as individual GeoJSON features. Extracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties.

parse string | object

If set to auto (the default), perform automatic type inference to determine the desired data types. Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of "number", "boolean" or "date"). For example, "parse": {"modified_on": "date"} parses the modified_on field in each input record a Date value.

For "date", we parse data based using Javascript's Date.parse(). For Specific date formats can be provided (e.g., {foo: 'date:"%m%d%Y"'}), using the d3-time-format syntax. UTC date format parsing is supported similarly (e.g., {foo: 'utc:"%m%d%Y"'}). See more about UTC time

type string

Type of input data: "json", "csv", "tsv". The default format type is determined by the extension of the file URL. If no extension is detected, "json" will be used by default.

Values: "topojson"
Transform FilterTransform | CalculateTransform | LookupTransform | BinTransform | TimeUnitTransform | AggregateTransform
Type string

Constants and utilities for data type
Data type based on level of measurement

UrlData object
url string required

An URL from which to load the data set. Use the format.type property to ensure the loaded data is correctly parsed.

UtcMultiTimeUnit string
UtcSingleTimeUnit string
VLOnlyConfig object
countTitle string

Default axis and legend title for count fields.

Default value: 'Number of Records'.

fieldTitle string

Defines how Vega-Lite generates title for fields. There are three possible styles:

  • "verbal" (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
  • "function" - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
  • "plain" - displays only the field name without functions (e.g., "field", "date", "field").
Values: "verbal" "functional" "plain"
invalidValues string

Defines how Vega-Lite should handle invalid values (null and NaN).

  • If set to "filter" (default), all data items with null values are filtered.
  • If null, all data items are included. In this case, invalid values will be interpreted as zeroes.
Values: "filter"
numberFormat string

D3 Number format for axis labels and text tables. For example "s" for SI units. Use D3's number format pattern.

scale object
19 nested properties
bandPaddingInner number

Default inner padding for x and y band-ordinal scales.

Default value: 0.1

min=0max=1
bandPaddingOuter number

Default outer padding for x and y band-ordinal scales. If not specified, by default, band scale's paddingOuter is paddingInner/2.

min=0max=1
clamp boolean

If true, values that exceed the data domain are clamped to either the minimum or maximum range value

continuousPadding number

Default padding for continuous scales.

Default: 5 for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; 0 otherwise.

min=0
maxBandSize number

The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's rangeStep - 1.

min=0
maxFontSize number

The default max value for mapping quantitative fields to text's size/fontSize.

Default value: 40

min=0
maxOpacity number

Default max opacity for mapping a field to opacity.

Default value: 0.8

min=0max=1
maxSize number

Default max value for point size scale.

min=0
maxStrokeWidth number

Default max strokeWidth for strokeWidth (or rule/line's size) scale.

Default value: 4

min=0
minBandSize number

The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

Default value: 2

min=0
minFontSize number

The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

Default value: 8

min=0
minOpacity number

Default minimum opacity for mapping a field to opacity.

Default value: 0.3

min=0max=1
minSize number

Default minimum value for point size scale with zero=false.

Default value: 9

min=0
minStrokeWidth number

Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

Default value: 1

min=0
pointPadding number

Default outer padding for x and y point-ordinal scales.

Default value: 0.5

min=0max=1
rangeStep number | null

Default range step for band and point scales of (1) the y channel and (2) the x channel when the mark is not text.

Default value: 21

min=0
round boolean

If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. (Only available for x, y, and size scales.)

textXRangeStep number

Default range step for x band and point scales of text marks.

Default value: 90

min=0
useUnaggregatedDomain boolean

Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting domain to "unaggregate" for aggregated quantitative fields by default.

This property only works with aggregate functions that produce values within the raw data domain ("mean", "average", "median", "q1", "q3", "min", "max"). For other aggregations that produce values outside of the raw data domain (e.g. "count", "sum"), this property is ignored.

Default value: false

selection object
3 nested properties
interval object
9 nested properties
bind string

Establishes a two-way binding between the interval selection and the scales used within the same view. This allows a user to interactively pan and zoom the view.

Values: "scales"
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

mark object
on
resolve string
Values: "global" "union" "intersect"
translate string | boolean

When truthy, allows a user to interactively move an interval selection back-and-forth. Can be true, false (to disable panning), or a Vega event stream definition which must include a start and end event to trigger continuous panning.

Default value: true, which corresponds to [mousedown, window:mouseup] > window:mousemove! which corresponds to clicks and dragging within an interval selection to reposition it.

zoom string | boolean

When truthy, allows a user to interactively resize an interval selection. Can be true, false (to disable zooming), or a Vega event stream definition. Currently, only wheel events are supported.

Default value: true, which corresponds to wheel!.

multi object
7 nested properties
empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
toggle string | boolean

Controls whether data values should be toggled or only ever inserted into multi selections. Can be true, false (for insertion only), or a Vega expression.

Default value: true, which corresponds to event.shiftKey (i.e., data values are toggled when a user interacts with the shift-key pressed).

See the toggle transform documentation for more information.

single object
7 nested properties
bind VgBinding | object

Establish a two-way binding between a single selection and input elements (also known as dynamic query widgets). A binding takes the form of Vega's input element binding definition or can be a mapping between projected field/encodings and binding definitions.

See the bind transform documentation for more information.

empty string

By default, all data values are considered to lie within an empty selection. When set to none, empty selections contain no data values.

Values: "all" "none"
encodings SingleDefChannel[]

An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.

fields string[]

An array of field names whose values must match for a data tuple to fall within the selection.

nearest boolean

When true, an invisible voronoi diagram is computed to accelerate discrete selection. The data value nearest the mouse cursor is added to the selection.

See the nearest transform documentation for more information.

on
resolve string
Values: "global" "union" "intersect"
stack string
Values: "zero" "center" "normalize"
timeFormat string

Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use D3's time format pattern.

Default value: '%b %d, %Y'.

view object
10 nested properties
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

ValueDef object

Definition object for a constant value of an encoding channel.

value number | string | boolean required

A constant value in visual domain (e.g., "red" / "#0099ff" for color, values between 0 to 1 for opacity).

MarkPropValueDefWithCondition object

A ValueDef with Condition<ValueDef | FieldDef> { condition: {field: ...} | {value: ...}, value: ..., }

A field definition or one or more value definition(s) with a selection predicate.

value number | string | boolean

A constant value in visual domain.

TextValueDefWithCondition object

A ValueDef with Condition<ValueDef | FieldDef> { condition: {field: ...} | {value: ...}, value: ..., }

A field definition or one or more value definition(s) with a selection predicate.

value number | string | boolean

A constant value in visual domain.

VerticalAlign string
VgAxisBase object

Base object for Vega's Axis and Axis Config. All of these properties are both properties of Vega's Axis and Axis Config.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickSize number

The size in pixels of axis ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

VgAxisConfig object
bandPosition number

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.

domain boolean

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

Default value: true

domainColor string

Color of axis domain line.

Default value: (none, using Vega default).

domainWidth number

Stroke width of axis domain line

Default value: (none, using Vega default).

grid boolean

A boolean flag indicating if grid lines should be included as part of the axis

Default value: true for continuous scales that are not binned; otherwise, false.

gridColor string

Color of gridlines.

gridDash number[]

The offset (in pixels) into which to begin drawing with the grid dash array.

gridOpacity number

The stroke opacity of grid (value between [0,1])

Default value: (1 by default)

min=0max=1
gridWidth number

The grid width, in pixels.

min=0
labelAngle number

The rotation angle of the axis labels.

Default value: -90 for nominal and ordinal fields; 0 otherwise.

min=-360max=360
labelBound boolean | number

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.

Default value: false.

labelColor string

The color of the tick label, can be in hex color code or regular color name.

labelFlush boolean | number

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.

Default value: true for axis of a continuous x-scale. Otherwise, false.

labelFont string

The font of the tick label.

labelFontSize number

The font size of the label, in pixels.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOverlap boolean | string | string

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).

Default value: true for non-nominal fields with non-log scales; "greedy" for log scales; otherwise false.

labelPadding number

The padding, in pixels, between axis and text labels.

labels boolean

A boolean flag indicating if labels should be included as part of the axis.

Default value: true.

maxExtent number

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Default value: undefined.

minExtent number

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Default value: 30 for y-axis; undefined for x-axis.

tickColor string

The color of the axis's tick.

tickRound boolean

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

tickSize number

The size in pixels of axis ticks.

min=0
tickWidth number

The width, in pixels, of ticks.

min=0
ticks boolean

Boolean value that determines whether the axis should include ticks.

titleAlign string

Horizontal text alignment of axis titles.

titleAngle number

Angle in degrees of axis titles.

titleBaseline string

Vertical text baseline for axis titles.

titleColor string

Color of the title, can be in hex color code or regular color name.

titleFont string

Font of the title. (e.g., "Helvetica Neue").

titleFontSize number

Font size of the title.

min=0
titleFontWeight string | number

Font weight of the title. (e.g., "bold").

titleLimit number

Maximum allowed pixel width of axis titles.

titleMaxLength number

Max length for axis title if the title is automatically generated from the field's description.

titlePadding number

The padding, in pixels, between title and axis.

titleX number

X-coordinate of the axis title relative to the axis group.

titleY number

Y-coordinate of the axis title relative to the axis group.

VgBinding VgCheckboxBinding | VgRadioBinding | VgSelectBinding | VgRangeBinding | VgGenericBinding
VgCheckboxBinding object
input string required
Values: "checkbox"
element string
VgEventStream
VgGenericBinding object
input string required
element string
VgLegendBase object
entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

VgLegendConfig object
cornerRadius number

Corner radius for the full legend.

entryPadding number

Padding (in pixels) between legend entries in a symbol legend.

fillColor string

Background fill color for the full legend.

gradientHeight number

The height of the gradient, in pixels.

min=0
gradientLabelBaseline string

Text baseline for color ramp gradient labels.

gradientLabelLimit number

The maximum allowed length in pixels of color ramp gradient labels.

gradientLabelOffset number

Vertical offset in pixels for color ramp gradient labels.

gradientStrokeColor string

The color of the gradient stroke, can be in hex color code or regular color name.

gradientStrokeWidth number

The width of the gradient stroke, in pixels.

min=0
gradientWidth number

The width of the gradient, in pixels.

min=0
labelAlign string

The alignment of the legend label, can be left, middle or right.

labelBaseline string

The position of the baseline of legend label, can be top, middle or bottom.

labelColor string

The color of the legend label, can be in hex color code or regular color name.

labelFont string

The font of the legend label.

labelFontSize number

The font size of legend label.

Default value: 10.

min=0
labelLimit number

Maximum allowed pixel width of axis tick labels.

labelOffset number

The offset of the legend label.

min=0
offset number

The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

Default value: 0

orient string
Values: "left" "right" "top-left" "top-right" "bottom-left" "bottom-right" "none"
padding number

The padding, in pixels, between the legend and axis.

strokeColor string

Border stroke color for the full legend.

strokeDash number[]

Border stroke dash pattern for the full legend.

strokeWidth number

Border stroke width for the full legend.

symbolColor string

The color of the legend symbol,

symbolSize number

The size of the legend symbol, in pixels.

min=0
symbolStrokeWidth number

The width of the symbol's stroke.

min=0
symbolType string

Default shape type (such as "circle") for legend symbols.

titleAlign string

Horizontal text alignment for legend titles.

titleBaseline string

Vertical text baseline for legend titles.

titleColor string

The color of the legend title, can be in hex color code or regular color name.

titleFont string

The font of the legend title.

titleFontSize number

The font size of the legend title.

titleFontWeight string | number

The font weight of the legend title.

titleLimit number

Maximum allowed pixel width of axis titles.

titlePadding number

The padding, in pixels, between title and legend.

VgMarkConfig object
align string
Values: "left" "right" "center"
angle number

The rotation angle of the text, in degrees.

min=0max=360
baseline string
Values: "top" "middle" "bottom"
dx number

The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

dy number

The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the angle property.

fill string

Default Fill Color. This has higher precedence than config.color

Default value: (None)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: 1

min=0max=1
font string

The typeface to set the text in (e.g., "Helvetica Neue").

fontSize number

The font size, in pixels.

min=0
fontStyle string
Values: "normal" "italic"

The font weight (e.g., "bold").

interpolate string
Values: "linear" "linear-closed" "step" "step-before" "step-after" "basis" "basis-open" "basis-closed" "cardinal" "cardinal-open" "cardinal-closed" "bundle" "monotone"
limit number

The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

opacity number

The overall opacity (value between [0,1]).

Default value: 0.7 for non-aggregate plots with point, tick, circle, or square marks or layered bar charts and 1 otherwise.

min=0max=1
orient string
Values: "horizontal" "vertical"
radius number

Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties.

min=0
shape string

The default symbol shape to use. One of: "circle" (default), "square", "cross", "diamond", "triangle-up", or "triangle-down", or a custom SVG path.

Default value: "circle"

size number

The pixel area each the point/circle/square. For example: in the case of circles, the radius is determined in part by the square root of the size value.

Default value: 30

min=0
stroke string

Default Stroke Color. This has higher precedence than config.color

Default value: (None)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: 1

min=0max=1
strokeWidth number

The stroke width, in pixels.

min=0
tension number

Depending on the interpolation type, sets the tension parameter (for line and area marks).

min=0max=1
text string

Placeholder text if the text channel is not specified

theta number

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".

VgRadioBinding object
input string required
Values: "radio"
options string[] required
element string
VgRangeBinding object
input string required
Values: "range"
element string
max number
min number
step number
VgScheme object
scheme string required
count number
extent number[]
VgSelectBinding object
input string required
Values: "select"
options string[] required
element string
VgTitleConfig object
anchor string
Values: "start" "middle" "end"
angle number

Angle in degrees of title text.

baseline string
Values: "top" "middle" "bottom"
color string

Text color for title text.

font string

Font name for title text.

fontSize number

Font size in pixels for title text.

Default value: 10.

min=0

Font weight for title text.

limit number

The maximum allowed length in pixels of legend labels.

min=0
offset number

Offset in pixels of the title from the chart body and axes.

orient string
Values: "top" "bottom" "left" "right"
ViewConfig object
clip boolean

Whether the view should be clipped.

fill string

The fill color.

Default value: (none)

fillOpacity number

The fill opacity (value between [0,1]).

Default value: (none)

height number

The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with rangeStep = null.

Default value: 200

stroke string

The stroke color.

Default value: (none)

strokeDash number[]

An array of alternating stroke, space lengths for creating dashed or dotted lines.

Default value: (none)

strokeDashOffset number

The offset (in pixels) into which to begin drawing with the stroke dash array.

Default value: (none)

strokeOpacity number

The stroke opacity (value between [0,1]).

Default value: (none)

strokeWidth number

The stroke width, in pixels.

Default value: (none)

width number

The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with rangeStep = null.

Default value: 200

VlOnlyGuideConfig object
shortTimeLabels boolean

Whether month names and weekday names should be abbreviated.

Default value: false