schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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 | name | Name of the visualization for later reference. | {"type": "string"} |
vega-lite.json | resolve | Scale, axis, and legend resolutions for vertically 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 | vconcat | A list of views that should be concatenated and put into a column. | {"items": {}, "type": "array"} |
vega-lite.json | format | The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.
See the [format documentation](format.html) for more information.
__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields. | {"type": "string"} |
vega-lite.json | title | A title for the field. If `null`, the title will be removed.
__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as a part of the title (e.g., `"Sum of Profit"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `"Profit (binned)"`, `"Transaction Date (year-month)"`). Otherwise, the title is simply the field name.
__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title). | {"type": ["string", "null"]} |
vega-lite.json | Header | Headers of row / column channels for faceted plots. | {"additionalProperties": false, "properties": {"format": {"type": "string"}}, "type": "object"} |
vega-lite.json | format | The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.
__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields. | {"type": "string"} |
vega-lite.json | title | A title for the axis. Shows field name and its function by default.
__Default value:__ derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)". | {"type": "string"} |
vega-lite.json | format | An object that specifies the format for parsing the data values. | {} |
vega-lite.json | values | The full data set, included inline. This can be an array of objects or primitive values or a string.
Arrays of primitive values are ingested as objects with a `data` property. Strings are parsed according to the specified format type. | {"anyOf": [{"items": {"type": "number"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}, {"items": {"type": "boolean"}, "type": "array"}, {"items": {"type": "object"}, "type": "array"}, {"type": "string"}, {"type": "object"}]} |
vega-lite.json | bind | Establishes a two-way binding between the interval selection and the scales
used within the same view. This allows a user to interactively pan and
zoom the view. | {"enum": ["scales"], "type": "string"} |
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 | mark | An interval selection also adds a rectangle mark to depict the
extents of the interval. The `mark` property can be used to customize the
appearance of the mark. | {} |
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 | translate | When truthy, allows a user to interactively move an interval selection
back-and-forth. Can be `true`, `false` (to disable panning), or a
[Vega event stream definition](https://vega.github.io/vega/docs/event-streams/)
which must include a start and end event to trigger continuous panning.
__Default value:__ `true`, which corresponds to
`[mousedown, window:mouseup] > window:mousemove!` which corresponds to
clicks and dragging within an interval selection to reposition it. | {"type": ["string", "boolean"]} |
vega-lite.json | zoom | When truthy, allows a user to interactively resize an interval selection.
Can be `true`, `false` (to disable zooming), or a [Vega event stream
definition](https://vega.github.io/vega/docs/event-streams/). Currently,
only `wheel` events are supported.
__Default value:__ `true`, which corresponds to `wheel!`. | {"type": ["string", "boolean"]} |
vega-lite.json | bind | Establishes a two-way binding between the interval selection and the scales
used within the same view. This allows a user to interactively pan and
zoom the view. | {"enum": ["scales"], "type": "string"} |
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 | mark | An interval selection also adds a rectangle mark to depict the
extents of the interval. The `mark` property can be used to customize the
appearance of the mark. | {} |
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 | translate | When truthy, allows a user to interactively move an interval selection
back-and-forth. Can be `true`, `false` (to disable panning), or a
[Vega event stream definition](https://vega.github.io/vega/docs/event-streams/)
which must include a start and end event to trigger continuous panning.
__Default value:__ `true`, which corresponds to
`[mousedown, window:mouseup] > window:mousemove!` which corresponds to
clicks and dragging within an interval selection to reposition it. | {"type": ["string", "boolean"]} |
vega-lite.json | zoom | When truthy, allows a user to interactively resize an interval selection.
Can be `true`, `false` (to disable zooming), or a [Vega event stream
definition](https://vega.github.io/vega/docs/event-streams/). Currently,
only `wheel` events are supported.
__Default value:__ `true`, which corresponds to `wheel!`. | {"type": ["string", "boolean"]} |
vega-lite.json | parse | If set to auto (the default), perform automatic type inference to determine the desired data types.
Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `"number"`, `"boolean"` or `"date"`).
For example, `"parse": {"modified_on": "date"}` parses the `modified_on` field in each input record a Date value.
For `"date"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
For Specific date formats can be provided (e.g., `{foo: 'date:"%m%d%Y"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:"%m%d%Y"'}`). See more about [UTC time](timeunit.html#utc) | {"anyOf": [{"enum": ["auto"], "type": "string"}, {"type": "object"}]} |
vega-lite.json | property | The JSON property containing the desired data.
This parameter can be used when the loaded JSON file may have surrounding structure or meta-data.
For example `"property": "values.features"` is equivalent to retrieving `json.values.features`
from the loaded JSON object. | {"type": "string"} |
vega-lite.json | type | Type of input data: `"json"`, `"csv"`, `"tsv"`.
The default format type is determined by the extension of the file URL.
If no extension is detected, `"json"` will be used by default. | {"enum": ["json"], "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 | 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 | Legend | Properties of a legend or boolean flag for determining whether to show it. | {"additionalProperties": false, "properties": {"entryPadding": {"type": "number"}, "format": {"type": "string"}, "offset": {"type": "number"}, "orient": {}, "padding": {"type": "number"}, "tickCount": {"type": "number"}, "type": {"enum": ["symbol", "gradient"], "type": "string"}, "values": {"anyOf": [{"items": {"type": "number"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}, {"items": {}, "type": "array"}]}, "zindex": {"minimum": 0, "type": "number"}}, "type": "object"} |
vega-lite.json | entryPadding | Padding (in pixels) between legend entries in a symbol legend. | {"type": "number"} |
vega-lite.json | format | The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.
See the [format documentation](format.html) for more information.
__Default value:__ derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields. | {"type": "string"} |
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 | tickCount | The desired number of tick values for quantitative legends. | {"type": "number"} |
vega-lite.json | title | A title for the field. If `null`, the title will be removed.
__Default value:__ derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`). If the field has an aggregate function, the function is displayed as a part of the title (e.g., `"Sum of Profit"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `"Profit (binned)"`, `"Transaction Date (year-month)"`). Otherwise, the title is simply the field name.
__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title). | {"type": ["string", "null"]} |
vega-lite.json | type | The type of the legend. Use `"symbol"` to create a discrete legend and `"gradient"` for a continuous color gradient.
__Default value:__ `"gradient"` for non-binned quantitative fields and temporal fields; `"symbol"` otherwise. | {"enum": ["symbol", "gradient"], "type": "string"} |
vega-lite.json | values | Explicitly set the visible legend values. | {"anyOf": [{"items": {"type": "number"}, "type": "array"}, {"items": {"type": "string"}, "type": "array"}, {"items": {}, "type": "array"}]} |
vega-lite.json | zindex | A non-positive integer indicating z-index of the legend.
If zindex is 0, legend should be drawn behind all chart elements.
To put them in front, use zindex = 1. | {"minimum": 0, "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 | shortTimeLabels | Whether month names and weekday names should be abbreviated.
__Default value:__ `false` | {"type": "boolean"} |
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 | data | Secondary data source to lookup in. | {} |
vega-lite.json | fields | Fields in foreign data to lookup.
If not specified, the entire object is queried. | {"items": {"type": "string"}, "type": "array"} |
vega-lite.json | key | Key in data to lookup. | {"type": "string"} |
vega-lite.json | as | The field or fields for storing the computed formula value.
If `from.fields` is specified, the transform will use the same names for `as`.
If `from.fields` is not specified, `as` has to be a string and we put the whole object into the data under the specified name. | {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]} |
vega-lite.json | default | The default value to use if lookup fails.
__Default value:__ `null` | {"type": "string"} |
vega-lite.json | from | Secondary data reference. | {} |
vega-lite.json | lookup | Key in primary data source. | {"type": "string"} |
vega-lite.json | Mark | All types of primitive marks. | {"enum": ["area", "bar", "line", "point", "text", "tick", "rect", "rule", "circle", "square"], "type": "string"} |
vega-lite.json | align | The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.