schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
vega-lite.json | color | 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](config.html#mark)'s `color` property.
_Note:_ See the scale documentation for more information about customizing [color scheme](scale.html#scheme). | {"anyOf": [{}, {}]} |
vega-lite.json | column | Horizontal facets for trellis plots. | {} |
vega-lite.json | detail | Additional levels of detail for grouping data in aggregate views and
in line and area marks without mapping data to a specific visual channel. | {"anyOf": [{}, {"items": {}, "type": "array"}]} |
vega-lite.json | opacity | Opacity of the marks – either can be a value or a range.
__Default value:__ If undefined, the default opacity depends on [mark config](config.html#mark)'s `opacity` property. | {"anyOf": [{}, {}]} |
vega-lite.json | order | 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 `aggregate`d to avoid creating additional aggregation grouping. | {"anyOf": [{}, {"items": {}, "type": "array"}]} |
vega-lite.json | row | Vertical facets for trellis plots. | {} |
vega-lite.json | shape | 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](config.html#point-config)'s `shape` property. | {"anyOf": [{}, {}]} |
vega-lite.json | size | 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"`. | {"anyOf": [{}, {}]} |
vega-lite.json | text | Text of the `text` mark. | {"anyOf": [{}, {}]} |
vega-lite.json | tooltip | The tooltip text to show upon mouse hover. | {"anyOf": [{}, {}]} |
vega-lite.json | x | X coordinates of the marks, or width of horizontal `"bar"` and `"area"`. | {"anyOf": [{}, {}]} |
vega-lite.json | x2 | X2 coordinates for ranged `"area"`, `"bar"`, `"rect"`, and `"rule"`. | {"anyOf": [{}, {}]} |
vega-lite.json | y | Y coordinates of the marks, or height of vertical `"bar"` and `"area"`. | {"anyOf": [{}, {}]} |
vega-lite.json | y2 | Y2 coordinates for ranged `"area"`, `"bar"`, `"rect"`, and `"rule"`. | {"anyOf": [{}, {}]} |
vega-lite.json | equal | The value that the field should be equal to. | {"anyOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}, {}]} |
vega-lite.json | field | Field to be filtered. | {"type": "string"} |
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"}, {}]} |
vega-lite.json | header | An object defining properties of a facet's header. | {} |
vega-lite.json | sort | Sort order for a facet field.
This can be `"ascending"`, `"descending"`. | {} |
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 | column | Horizontal facets for trellis plots. | {} |
vega-lite.json | row | Vertical facets for trellis plots. | {} |
vega-lite.json | FacetedUnitSpec | Unit spec that can have a composite mark and row or column channels. | {} |
vega-lite.json | FieldDef | Definition object for a data field, its type and transformation of an encoding channel. | {"additionalProperties": false, "properties": {"aggregate": {}, "bin": {"anyOf": [{"type": "boolean"}, {}]}, "field": {"anyOf": [{"type": "string"}, {}]}, "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 | 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 | 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 | 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 | MarkPropFieldDefWithCondition | A FieldDef with Condition<ValueDef>
{
condition: {value: ...},
field: ...,
...
} | {"additionalProperties": false, "properties": {"aggregate": {}, "bin": {"anyOf": [{"type": "boolean"}, {}]}, "condition": {"anyOf": [{}, {"items": {}, "type": "array"}]}, "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 | condition | One or more value definition(s) with a selection predicate.
__Note:__ A field definition's `condition` property can only contain [value definitions](encoding.html#value)
since Vega-Lite only allows at mosty one encoded field per encoding channel. | {"anyOf": [{}, {"items": {}, "type": "array"}]} |
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 | TextFieldDefWithCondition | A FieldDef with Condition<ValueDef>
{
condition: {value: ...},
field: ...,
...
} | {"additionalProperties": false, "properties": {"aggregate": {}, "bin": {"anyOf": [{"type": "boolean"}, {}]}, "condition": {"anyOf": [{}, {"items": {}, "type": "array"}]}, "field": {"anyOf": [{"type": "string"}, {}]}, "format": {"type": "string"}, "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 | condition | One or more value definition(s) with a selection predicate.
__Note:__ A field definition's `condition` property can only contain [value definitions](encoding.html#value)
since Vega-Lite only allows at mosty one encoded field per encoding channel. | {"anyOf": [{}, {"items": {}, "type": "array"}]} |
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 | filter | The `filter` property must be either (1) a filter object for [equal-filters](filter.html#equalfilter),
[range-filters](filter.html#rangefilter), [one-of filters](filter.html#oneoffilter), or [selection filters](filter.html#selectionfilter);
(2) a [Vega Expression](filter.html#expression) string,
where `datum` can be used to refer to the current data object; or (3) an array of filters (either objects or expression strings) that must all be true for a datum to pass the filter and be included. | {} |
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 | 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 | data | An object describing the data source | {} |
vega-lite.json | description | Description of this mark for commenting purpose. | {"type": "string"} |
vega-lite.json | hconcat | A list of views that should be concatenated and put into a row. | {"items": {}, "type": "array"} |
vega-lite.json | name | Name of the visualization for later reference. | {"type": "string"} |
vega-lite.json | resolve | Scale, axis, and legend resolutions for horizontally concatenated charts. | {} |
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 | data | An object describing the data source | {} |
vega-lite.json | description | Description of this mark for commenting purpose. | {"type": "string"} |
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 | layer | 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. | {"items": {"anyOf": [{}, {}]}, "type": "array"} |
vega-lite.json | name | Name of the visualization for later reference. | {"type": "string"} |
vega-lite.json | resolve | Scale, axis, and legend resolutions for layers. | {} |
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 | 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 | repeat | An object that describes what fields should be repeated into views that are laid out as a `row` or `column`. | {} |
vega-lite.json | resolve | Scale and legend resolutions for repeated charts. | {} |
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 | 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 | 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 | 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. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.