schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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 | shortTimeLabels | Whether month names and weekday names should be abbreviated. | {"type": "boolean"} |
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 | 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 | format | The [formatting pattern](format.html) for a text field. If not defined, this will be determined automatically. | {"type": "string"} |
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 | 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 | bandSize | The width of the ticks.
__Default value:__ 2/3 of rangeStep. | {"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 | thickness | Thickness of the tick mark.
__Default value:__ `1` | {"minimum": 0, "type": "number"} |
vega-lite.json | as | The output field to write the timeUnit value. | {"type": "string"} |
vega-lite.json | field | The data field to apply time unit. | {"type": "string"} |
vega-lite.json | timeUnit | The timeUnit. | {} |
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 | offset | The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart. | {"type": "number"} |
vega-lite.json | orient | The orientation of the title relative to the chart. One of `"top"` (the default), `"bottom"`, `"left"`, or `"right"`. | {} |
vega-lite.json | style | A [mark style property](config.html#style) to apply to the title text mark.
__Default value:__ `"group-title"`. | {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]} |
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 | offset | The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart. | {"type": "number"} |
vega-lite.json | orient | The orientation of the title relative to the chart. One of `"top"` (the default), `"bottom"`, `"left"`, or `"right"`. | {} |
vega-lite.json | style | A [mark style property](config.html#style) to apply to the title text mark.
__Default value:__ `"group-title"`. | {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]} |
vega-lite.json | text | The title text. | {"type": "string"} |
vega-lite.json | $schema | URL to [JSON schema](http://json-schema.org/) 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", "type": "string"} |
vega-lite.json | autosize | 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` | {"anyOf": [{}, {}]} |
vega-lite.json | background | CSS color property to use as the background of visualization.
__Default value:__ none (transparent) | {"type": "string"} |
vega-lite.json | config | Vega-Lite configuration object. This property can only be defined at the top-level of a specification. | {} |
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 | encoding | A key-value mapping between encoding channels and definition of fields. | {} |
vega-lite.json | height | The height of a visualization.
__Default value:__
- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).
- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).
- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.
__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.
__See also:__ The documentation for [width and height](size.html) contains more examples. | {"type": "number"} |
vega-lite.json | mark | A string describing the mark type (one of `"bar"`, `"circle"`, `"square"`, `"tick"`, `"line"`,
`"area"`, `"point"`, `"rule"`, and `"text"`) or a [mark definition object](mark.html#mark-def). | {} |
vega-lite.json | name | Name of the visualization for later reference. | {"type": "string"} |
vega-lite.json | padding | The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.
If an object, the value should have the format `{"left": 5, "top": 5, "right": 5, "bottom": 5}` to specify padding for each side of the visualization.
__Default value__: `5` | {} |
vega-lite.json | selection | A key-value mapping between selection names and definitions. | {"additionalProperties": {}, "type": "object"} |
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 | width | The width of a visualization.
__Default value:__ This will be determined by the following rules:
- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).
- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).
- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.
__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.
__See also:__ The documentation for [width and height](size.html) contains more examples. | {"type": "number"} |
vega-lite.json | $schema | URL to [JSON schema](http://json-schema.org/) 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", "type": "string"} |
vega-lite.json | autosize | 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` | {"anyOf": [{}, {}]} |
vega-lite.json | background | CSS color property to use as the background of visualization.
__Default value:__ none (transparent) | {"type": "string"} |
vega-lite.json | config | Vega-Lite configuration object. This property can only be defined at the top-level of a specification. | {} |
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 | facet | An object that describes mappings between `row` and `column` channels and their field definitions. | {} |
vega-lite.json | name | Name of the visualization for later reference. | {"type": "string"} |
vega-lite.json | padding | The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides.
If an object, the value should have the format `{"left": 5, "top": 5, "right": 5, "bottom": 5}` to specify padding for each side of the visualization.
__Default value__: `5` | {} |
vega-lite.json | resolve | Scale, axis, and legend resolutions for facets. | {} |
vega-lite.json | spec | A specification of the view that gets faceted. | {"anyOf": [{}, {}]} |
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 | $schema | URL to [JSON schema](http://json-schema.org/) 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", "type": "string"} |
vega-lite.json | autosize | 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` | {"anyOf": [{}, {}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.