schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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;">■</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"} |
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 | area | Area-Specific Config | {} |
vega-lite.json | bar | Bar-Specific Config | {} |
vega-lite.json | circle | Circle-Specific Config | {} |
vega-lite.json | line | Line-Specific Config | {} |
vega-lite.json | mark | Mark Config | {} |
vega-lite.json | point | Point-Specific Config | {} |
vega-lite.json | rect | Rect-Specific Config | {} |
vega-lite.json | rule | Rule-Specific Config | {} |
vega-lite.json | square | Square-Specific Config | {} |
vega-lite.json | text | Text-Specific Config | {} |
vega-lite.json | tick | Tick-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 | clip | Whether a mark be clipped to the enclosing group's width and height. | {"type": "boolean"} |
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;">■</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"} |
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 | style | 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](mark.html#style-config). If style is an array, later styles will override earlier styles. Any [mark properties](encoding.html#mark-prop) 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). | {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]} |
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 | type | The mark type.
One of `"bar"`, `"circle"`, `"square"`, `"tick"`, `"line"`,
`"area"`, `"point"`, `"rule"`, and `"text"`. | {} |
vega-lite.json | MarkPropFieldDef | Field definition of a mark property, which can contain a legend. | {"additionalProperties": false, "properties": {"aggregate": {}, "bin": {"anyOf": [{"type": "boolean"}, {}]}, "field": {"anyOf": [{"type": "string"}, {}]}, "legend": {"anyOf": [{}, {"type": "null"}]}, "scale": {}, "sort": {"anyOf": [{}, {}, {"type": "null"}]}, "timeUnit": {}, "type": {}}, "required": ["type"], "type": "object"} |
vega-lite.json | aggregate | Aggregation function for the field
(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).
__Default value:__ `undefined` (None) | {} |
vega-lite.json | bin | A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).
If `true`, default [binning parameters](bin.html) will be applied.
__Default value:__ `false` | {"anyOf": [{"type": "boolean"}, {}]} |
vega-lite.json | field | __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`](repeat.html) operator.
__Note:__ `field` is not required if `aggregate` is `count`. | {"anyOf": [{"type": "string"}, {}]} |
vega-lite.json | legend | 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](legend.html) are applied. | {"anyOf": [{}, {"type": "null"}]} |
vega-lite.json | scale | An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.
__Default value:__ If undefined, default [scale properties](scale.html) are applied. | {} |
vega-lite.json | sort | 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](sort.html#sort-field).
__Default value:__ `"ascending"` | {"anyOf": [{}, {}, {"type": "null"}]} |
vega-lite.json | timeUnit | Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.
or [a temporal field that gets casted as ordinal](type.html#cast).
__Default value:__ `undefined` (None) | {} |
vega-lite.json | type | The encoded field's type of measurement (`"quantitative"`, `"temporal"`, `"ordinal"`, or `"nominal"`). | {} |
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 | nearest | 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](nearest.html) documentation for more information. | {"type": "boolean"} |
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 | toggle | 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](https://vega.github.io/vega/docs/expressions/).
__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](toggle.html) documentation for more information. | {"type": ["string", "boolean"]} |
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 | nearest | 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](nearest.html) documentation for more information. | {"type": "boolean"} |
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 | toggle | 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](https://vega.github.io/vega/docs/expressions/).
__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](toggle.html) documentation for more information. | {"type": ["string", "boolean"]} |
vega-lite.json | format | An object that specifies the format for parsing the data. | {} |
vega-lite.json | name | Provide a placeholder name and bind data at runtime. | {"type": "string"} |
vega-lite.json | field | Field to be filtered | {"type": "string"} |
vega-lite.json | properties | A set of values that the `field`'s value should be a member of,
for a data item included in the filtered data. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"items": {"type": "number"}, "type": "array"}, {"items": {"type": "boolean"}, "type": "array"}, {"items": {}, "type": "array"}]} |
vega-lite.json | timeUnit | time unit for the field to be filtered. | {} |
vega-lite.json | aggregate | Aggregation function for the field
(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).
__Default value:__ `undefined` (None) | {} |
vega-lite.json | bin | A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).
If `true`, default [binning parameters](bin.html) will be applied.
__Default value:__ `false` | {"anyOf": [{"type": "boolean"}, {}]} |
vega-lite.json | field | __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`](repeat.html) operator.
__Note:__ `field` is not required if `aggregate` is `count`. | {"anyOf": [{"type": "string"}, {}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.