schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
vega-lite.json
ticks
Boolean value that determines whether the axis should include ticks.
{"type": "boolean"}
vega-lite.json
titleAlign
Horizontal text alignment of axis titles.
{"type": "string"}
vega-lite.json
titleAngle
Angle in degrees of axis titles.
{"type": "number"}
vega-lite.json
titleBaseline
Vertical text baseline for axis titles.
{"type": "string"}
vega-lite.json
titleColor
Color of the title, can be in hex color code or regular color name.
{"type": "string"}
vega-lite.json
titleFont
Font of the title. (e.g., `"Helvetica Neue"`).
{"type": "string"}
vega-lite.json
titleFontSize
Font size of the title.
{"minimum": 0, "type": "number"}
vega-lite.json
titleFontWeight
Font weight of the title. (e.g., `"bold"`).
{"type": ["string", "number"]}
vega-lite.json
titleLimit
Maximum allowed pixel width of axis titles.
{"type": "number"}
vega-lite.json
titleMaxLength
Max length for axis title if the title is automatically generated from the field's description.
{"type": "number"}
vega-lite.json
titlePadding
The padding, in pixels, between title and axis.
{"type": "number"}
vega-lite.json
titleX
X-coordinate of the axis title relative to the axis group.
{"type": "number"}
vega-lite.json
titleY
Y-coordinate of the axis title relative to the axis group.
{"type": "number"}
vega-lite.json
axis
Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config).
{}
vega-lite.json
axisBand
Specific axis config for axes with "band" scales.
{}
vega-lite.json
axisBottom
Specific axis config for x-axis along the bottom edge of the chart.
{}
vega-lite.json
axisLeft
Specific axis config for y-axis along the left edge of the chart.
{}
vega-lite.json
axisRight
Specific axis config for y-axis along the right edge of the chart.
{}
vega-lite.json
axisTop
Specific axis config for x-axis along the top edge of the chart.
{}
vega-lite.json
axisX
X-axis specific config.
{}
vega-lite.json
axisY
Y-axis specific config.
{}
vega-lite.json
align
The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.
{}
vega-lite.json
angle
The rotation angle of the text, in degrees.
{"maximum": 360, "minimum": 0, "type": "number"}
vega-lite.json
baseline
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`. __Default value:__ `"middle"`
{}
vega-lite.json
binSpacing
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`
{"minimum": 0, "type": "number"}
vega-lite.json
color
Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`. __Default value:__ <span style="color: #4682b4;">&#9632;</span> `"#4682b4"` __Note:__ This property cannot be used in a [style config](mark.html#style-config).
{"type": "string"}
vega-lite.json
continuousBandSize
The default size of the bars on continuous scales. __Default value:__ `5`
{"minimum": 0, "type": "number"}
vega-lite.json
discreteBandSize
The size of the bars. If unspecified, the default size is `bandSize-1`, which provides 1 pixel offset between bars.
{"minimum": 0, "type": "number"}
vega-lite.json
dx
The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.
{"type": "number"}
vega-lite.json
dy
The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.
{"type": "number"}
vega-lite.json
fill
Default Fill Color. This has higher precedence than config.color __Default value:__ (None)
{"type": "string"}
vega-lite.json
fillOpacity
The fill opacity (value between [0,1]). __Default value:__ `1`
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
filled
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](mark.html#style-config).
{"type": "boolean"}
vega-lite.json
font
The typeface to set the text in (e.g., `"Helvetica Neue"`).
{"type": "string"}
vega-lite.json
fontSize
The font size, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
fontStyle
The font style (e.g., `"italic"`).
{}
vega-lite.json
fontWeight
The font weight (e.g., `"bold"`).
{"anyOf": [{}, {}]}
vega-lite.json
interpolate
The line interpolation method to use for line and area marks. One of the following: - `"linear"`: piecewise linear segments, as in a polyline. - `"linear-closed"`: close the linear segments to form a polygon. - `"step"`: alternate between horizontal and vertical segments, as in a step function. - `"step-before"`: alternate between vertical and horizontal segments, as in a step function. - `"step-after"`: alternate between horizontal and vertical segments, as in a step function. - `"basis"`: a B-spline, with control point duplication on the ends. - `"basis-open"`: an open B-spline; may not intersect the start or end. - `"basis-closed"`: a closed B-spline, as in a loop. - `"cardinal"`: a Cardinal spline, with control point duplication on the ends. - `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points. - `"cardinal-closed"`: a closed Cardinal spline, as in a loop. - `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline. - `"monotone"`: cubic interpolation that preserves monotonicity in y.
{}
vega-lite.json
limit
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.
{"type": "number"}
vega-lite.json
opacity
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.
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
orient
The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. - For bar, rule and tick, this determines whether the size of the bar and tick should be applied to x or y dimension. - For area, this property determines the orient property of the Vega output. - For line, this property determines the sort order of the points in the line if `config.sortLineBy` is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.
{}
vega-lite.json
radius
Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.
{"minimum": 0, "type": "number"}
vega-lite.json
shape
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"`
{"type": "string"}
vega-lite.json
size
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`
{"minimum": 0, "type": "number"}
vega-lite.json
stroke
Default Stroke Color. This has higher precedence than config.color __Default value:__ (None)
{"type": "string"}
vega-lite.json
strokeDash
An array of alternating stroke, space lengths for creating dashed or dotted lines.
{"items": {"type": "number"}, "type": "array"}
vega-lite.json
strokeDashOffset
The offset (in pixels) into which to begin drawing with the stroke dash array.
{"type": "number"}
vega-lite.json
strokeOpacity
The stroke opacity (value between [0,1]). __Default value:__ `1`
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
strokeWidth
The stroke width, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
tension
Depending on the interpolation type, sets the tension parameter (for line and area marks).
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
text
Placeholder text if the `text` channel is not specified
{"type": "string"}
vega-lite.json
theta
Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating "north".
{"type": "number"}
vega-lite.json
base
The number base to use for automatic bin determination (default is base 10). __Default value:__ `10`
{"type": "number"}
vega-lite.json
divide
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]`
{"items": {"type": "number"}, "minItems": 1, "type": "array"}
vega-lite.json
maxbins
Maximum number of bins. __Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels
{"minimum": 2, "type": "number"}
vega-lite.json
minstep
A minimum allowable step size (particularly useful for integer values).
{"type": "number"}
vega-lite.json
nice
If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.
{"type": "boolean"}
vega-lite.json
step
An exact step size to use between bins. __Note:__ If provided, options such as maxbins will be ignored.
{"type": "number"}
vega-lite.json
steps
An array of allowable step sizes to choose from.
{"items": {"type": "number"}, "minItems": 1, "type": "array"}
vega-lite.json
empty
By default, all data values are considered to lie within an empty selection. When set to `none`, empty selections contain no data values.
{"enum": ["all", "none"], "type": "string"}
vega-lite.json
encodings
An array of encoding channels. The corresponding data field values must match for a data tuple to fall within the selection.
{"items": {}, "type": "array"}
vega-lite.json
fields
An array of field names whose values must match for a data tuple to fall within the selection.
{"items": {"type": "string"}, "type": "array"}
vega-lite.json
on
A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection. For interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters).
{}
vega-lite.json
resolve
With layered and multi-view displays, a strategy that determines how selections' data queries are resolved when applied in a filter transform, conditional encoding rule, or scale domain.
{}
vega-lite.json
data
An object describing the data source
{}
vega-lite.json
description
Description of this mark for commenting purpose.
{"type": "string"}
vega-lite.json
name
Name of the visualization for later reference.
{"type": "string"}
vega-lite.json
title
Title for the plot.
{"anyOf": [{"type": "string"}, {}]}
vega-lite.json
transform
An array of data transformations such as filter and new field calculation.
{"items": {}, "type": "array"}
vega-lite.json
BinParams
Binning properties or boolean flag for determining whether to bin data or not.
{"additionalProperties": false, "properties": {"base": {"type": "number"}, "divide": {"items": {"type": "number"}, "minItems": 1, "type": "array"}, "extent": {"items": {"type": "number"}, "maxItems": 2, "minItems": 2, "type": "array"}, "maxbins": {"minimum": 2, "type": "number"}, "minstep": {"type": "number"}, "nice": {"type": "boolean"}, "step": {"type": "number"}, "steps": {"items": {"type": "number"}, "minItems": 1, "type": "array"}}, "type": "object"}
vega-lite.json
base
The number base to use for automatic bin determination (default is base 10). __Default value:__ `10`
{"type": "number"}
vega-lite.json
divide
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]`
{"items": {"type": "number"}, "minItems": 1, "type": "array"}
vega-lite.json
extent
A two-element (`[min, max]`) array indicating the range of desired bin values.
{"items": {"type": "number"}, "maxItems": 2, "minItems": 2, "type": "array"}
vega-lite.json
maxbins
Maximum number of bins. __Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels
{"minimum": 2, "type": "number"}
vega-lite.json
minstep
A minimum allowable step size (particularly useful for integer values).
{"type": "number"}
vega-lite.json
nice
If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.
{"type": "boolean"}
vega-lite.json
step
An exact step size to use between bins. __Note:__ If provided, options such as maxbins will be ignored.
{"type": "number"}
vega-lite.json
steps
An array of allowable step sizes to choose from.
{"items": {"type": "number"}, "minItems": 1, "type": "array"}
vega-lite.json
as
The output fields at which to write the start and end bin values.
{"type": "string"}
vega-lite.json
bin
An object indicating bin properties, or simply `true` for using default bin parameters.
{"anyOf": [{"type": "boolean"}, {}]}
vega-lite.json
field
The data field to bin.
{"type": "string"}
vega-lite.json
align
The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.
{}
vega-lite.json
angle
The rotation angle of the text, in degrees.
{"maximum": 360, "minimum": 0, "type": "number"}
vega-lite.json
baseline
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`. __Default value:__ `"middle"`
{}
vega-lite.json
color
Default color. Note that `fill` and `stroke` have higher precedence than `color` and will override `color`. __Default value:__ <span style="color: #4682b4;">&#9632;</span> `"#4682b4"` __Note:__ This property cannot be used in a [style config](mark.html#style-config).
{"type": "string"}
vega-lite.json
dx
The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.
{"type": "number"}
vega-lite.json
dy
The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.
{"type": "number"}
vega-lite.json
fill
Default Fill Color. This has higher precedence than config.color __Default value:__ (None)
{"type": "string"}
vega-lite.json
fillOpacity
The fill opacity (value between [0,1]). __Default value:__ `1`
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
filled
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](mark.html#style-config).
{"type": "boolean"}
vega-lite.json
font
The typeface to set the text in (e.g., `"Helvetica Neue"`).
{"type": "string"}
vega-lite.json
fontSize
The font size, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
fontStyle
The font style (e.g., `"italic"`).
{}
vega-lite.json
fontWeight
The font weight (e.g., `"bold"`).
{"anyOf": [{}, {}]}
vega-lite.json
interpolate
The line interpolation method to use for line and area marks. One of the following: - `"linear"`: piecewise linear segments, as in a polyline. - `"linear-closed"`: close the linear segments to form a polygon. - `"step"`: alternate between horizontal and vertical segments, as in a step function. - `"step-before"`: alternate between vertical and horizontal segments, as in a step function. - `"step-after"`: alternate between horizontal and vertical segments, as in a step function. - `"basis"`: a B-spline, with control point duplication on the ends. - `"basis-open"`: an open B-spline; may not intersect the start or end. - `"basis-closed"`: a closed B-spline, as in a loop. - `"cardinal"`: a Cardinal spline, with control point duplication on the ends. - `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points. - `"cardinal-closed"`: a closed Cardinal spline, as in a loop. - `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline. - `"monotone"`: cubic interpolation that preserves monotonicity in y.
{}
vega-lite.json
limit
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.
{"type": "number"}
vega-lite.json
opacity
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.
{"maximum": 1, "minimum": 0, "type": "number"}
vega-lite.json
orient
The orientation of a non-stacked bar, tick, area, and line charts. The value is either horizontal (default) or vertical. - For bar, rule and tick, this determines whether the size of the bar and tick should be applied to x or y dimension. - For area, this property determines the orient property of the Vega output. - For line, this property determines the sort order of the points in the line if `config.sortLineBy` is not specified. For stacked charts, this is always determined by the orientation of the stack; therefore explicitly specified value will be ignored.
{}
vega-lite.json
radius
Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.
{"minimum": 0, "type": "number"}
vega-lite.json
shape
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"`
{"type": "string"}