schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
vega-lite.json
labelBound
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`.
{"type": ["boolean", "number"]}
vega-lite.json
labelColor
The color of the tick label, can be in hex color code or regular color name.
{"type": "string"}
vega-lite.json
labelFlush
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`.
{"type": ["boolean", "number"]}
vega-lite.json
labelFont
The font of the tick label.
{"type": "string"}
vega-lite.json
labelFontSize
The font size of the label, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
labelLimit
Maximum allowed pixel width of axis tick labels.
{"type": "number"}
vega-lite.json
labelOverlap
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`.
{"anyOf": [{"type": "boolean"}, {"enum": ["parity"], "type": "string"}, {"enum": ["greedy"], "type": "string"}]}
vega-lite.json
labelPadding
The padding, in pixels, between axis and text labels.
{"type": "number"}
vega-lite.json
labels
A boolean flag indicating if labels should be included as part of the axis. __Default value:__ `true`.
{"type": "boolean"}
vega-lite.json
maxExtent
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ `undefined`.
{"type": "number"}
vega-lite.json
minExtent
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.
{"type": "number"}
vega-lite.json
tickColor
The color of the axis's tick.
{"type": "string"}
vega-lite.json
tickRound
Boolean flag indicating if pixel position values should be rounded to the nearest integer.
{"type": "boolean"}
vega-lite.json
tickSize
The size in pixels of axis ticks.
{"minimum": 0, "type": "number"}
vega-lite.json
tickWidth
The width, in pixels, of ticks.
{"minimum": 0, "type": "number"}
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
entryPadding
Padding (in pixels) between legend entries in a symbol legend.
{"type": "number"}
vega-lite.json
offset
The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle. __Default value:__ `0`
{"type": "number"}
vega-lite.json
orient
The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none". __Default value:__ `"right"`
{}
vega-lite.json
padding
The padding, in pixels, between the legend and axis.
{"type": "number"}
vega-lite.json
cornerRadius
Corner radius for the full legend.
{"type": "number"}
vega-lite.json
entryPadding
Padding (in pixels) between legend entries in a symbol legend.
{"type": "number"}
vega-lite.json
fillColor
Background fill color for the full legend.
{"type": "string"}
vega-lite.json
gradientHeight
The height of the gradient, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
gradientLabelBaseline
Text baseline for color ramp gradient labels.
{"type": "string"}
vega-lite.json
gradientLabelLimit
The maximum allowed length in pixels of color ramp gradient labels.
{"type": "number"}
vega-lite.json
gradientLabelOffset
Vertical offset in pixels for color ramp gradient labels.
{"type": "number"}
vega-lite.json
gradientStrokeColor
The color of the gradient stroke, can be in hex color code or regular color name.
{"type": "string"}
vega-lite.json
gradientStrokeWidth
The width of the gradient stroke, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
gradientWidth
The width of the gradient, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
labelAlign
The alignment of the legend label, can be left, middle or right.
{"type": "string"}
vega-lite.json
labelBaseline
The position of the baseline of legend label, can be top, middle or bottom.
{"type": "string"}
vega-lite.json
labelColor
The color of the legend label, can be in hex color code or regular color name.
{"type": "string"}
vega-lite.json
labelFont
The font of the legend label.
{"type": "string"}
vega-lite.json
labelFontSize
The font size of legend label. __Default value:__ `10`.
{"minimum": 0, "type": "number"}
vega-lite.json
labelLimit
Maximum allowed pixel width of axis tick labels.
{"type": "number"}
vega-lite.json
labelOffset
The offset of the legend label.
{"minimum": 0, "type": "number"}
vega-lite.json
offset
The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle. __Default value:__ `0`
{"type": "number"}
vega-lite.json
orient
The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none". __Default value:__ `"right"`
{}
vega-lite.json
padding
The padding, in pixels, between the legend and axis.
{"type": "number"}
vega-lite.json
strokeColor
Border stroke color for the full legend.
{"type": "string"}
vega-lite.json
strokeDash
Border stroke dash pattern for the full legend.
{"items": {"type": "number"}, "type": "array"}
vega-lite.json
strokeWidth
Border stroke width for the full legend.
{"type": "number"}
vega-lite.json
symbolColor
The color of the legend symbol,
{"type": "string"}
vega-lite.json
symbolSize
The size of the legend symbol, in pixels.
{"minimum": 0, "type": "number"}
vega-lite.json
symbolStrokeWidth
The width of the symbol's stroke.
{"minimum": 0, "type": "number"}
vega-lite.json
symbolType
Default shape type (such as "circle") for legend symbols.
{"type": "string"}
vega-lite.json
titleAlign
Horizontal text alignment for legend titles.
{"type": "string"}
vega-lite.json
titleBaseline
Vertical text baseline for legend titles.
{"type": "string"}
vega-lite.json
titleColor
The color of the legend title, can be in hex color code or regular color name.
{"type": "string"}
vega-lite.json
titleFont
The font of the legend title.
{"type": "string"}
vega-lite.json
titleFontSize
The font size of the legend title.
{"type": "number"}
vega-lite.json
titleFontWeight
The font weight of the legend title.
{"type": ["string", "number"]}
vega-lite.json
titleLimit
Maximum allowed pixel width of axis titles.
{"type": "number"}
vega-lite.json
titlePadding
The padding, in pixels, between title and legend.
{"type": "number"}
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
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
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
anchor
The anchor position for placing the title. One of `"start"`, `"middle"`, or `"end"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title. __Default value:__ `"middle"` for [single](spec.html) and [layered](layer.html) views. `"start"` for other composite views. __Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views. For other composite views, `anchor` is always `"start"`.
{}
vega-lite.json
angle
Angle in degrees of title text.
{"type": "number"}
vega-lite.json
baseline
Vertical text baseline for title text.
{}
vega-lite.json
color
Text color for title text.
{"type": "string"}
vega-lite.json
font
Font name for title text.
{"type": "string"}
vega-lite.json
fontSize
Font size in pixels for title text. __Default value:__ `10`.
{"minimum": 0, "type": "number"}
vega-lite.json
fontWeight
Font weight for title text.
{"anyOf": [{}, {}]}