schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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 | 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 | 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 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 | $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 | 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 | 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 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 | $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 | 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 | 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 | $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 | 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 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 | 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 | 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 | feature | The name of the TopoJSON object set to convert to a GeoJSON feature collection.
For example, in a map of the world, there may be an object set named `"countries"`.
Using the feature property, we can extract this set and generate a GeoJSON feature object for each country. | {"type": "string"} |
vega-lite.json | mesh | The name of the TopoJSON object set to convert to mesh.
Similar to the `feature` option, `mesh` extracts a named TopoJSON object set.
Unlike the `feature` option, the corresponding geo data is returned as a single, unified mesh instance, not as individual GeoJSON features.
Extracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties. | {"type": "string"} |
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 | 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": ["topojson"], "type": "string"} |
vega-lite.json | Type | Constants and utilities for data type
Data type based on level of measurement | {"enum": ["quantitative", "ordinal", "temporal", "nominal"], "type": "string"} |
vega-lite.json | format | An object that specifies the format for parsing the data file. | {} |
vega-lite.json | url | An URL from which to load the data set. Use the `format.type` property
to ensure the loaded data is correctly parsed. | {"type": "string"} |
vega-lite.json | countTitle | Default axis and legend title for count fields.
__Default value:__ `'Number of Records'`. | {"type": "string"} |
vega-lite.json | fieldTitle | Defines how Vega-Lite generates title for fields. There are three possible styles:
- `"verbal"` (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
- `"function"` - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
- `"plain"` - displays only the field name without functions (e.g., "field", "date", "field"). | {"enum": ["verbal", "functional", "plain"], "type": "string"} |
vega-lite.json | invalidValues | Defines how Vega-Lite should handle invalid values (`null` and `NaN`).
- If set to `"filter"` (default), all data items with null values are filtered.
- If `null`, all data items are included. In this case, invalid values will be interpreted as zeroes. | {"enum": ["filter"], "type": "string"} |
vega-lite.json | numberFormat | D3 Number format for axis labels and text tables. For example "s" for SI units. Use [D3's number format pattern](https://github.com/d3/d3-format#locale_format). | {"type": "string"} |
vega-lite.json | scale | Scale configuration determines default properties for all [scales](scale.html). For a full list of scale configuration options, please see the [corresponding section of the scale documentation](scale.html#config). | {} |
vega-lite.json | selection | An object hash for defining default properties for each type of selections. | {} |
vega-lite.json | stack | Default stack offset for stackable mark. | {} |
vega-lite.json | timeFormat | Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use [D3's time format pattern](https://github.com/d3/d3-time-format#locale_format).
__Default value:__ `'%b %d, %Y'`. | {"type": "string"} |
vega-lite.json | view | Default properties for [single view plots](spec.html#single). | {} |
vega-lite.json | ValueDef | Definition object for a constant value of an encoding channel. | {"additionalProperties": false, "properties": {"value": {"type": ["number", "string", "boolean"]}}, "required": ["value"], "type": "object"} |
vega-lite.json | value | A constant value in visual domain (e.g., `"red"` / "#0099ff" for color, values between `0` to `1` for opacity). | {"type": ["number", "string", "boolean"]} |
vega-lite.json | MarkPropValueDefWithCondition | A ValueDef with Condition<ValueDef | FieldDef>
{
condition: {field: ...} | {value: ...},
value: ...,
} | {"additionalProperties": false, "properties": {"condition": {"anyOf": [{}, {}, {"items": {}, "type": "array"}]}, "value": {"type": ["number", "string", "boolean"]}}, "type": "object"} |
vega-lite.json | condition | A field definition or one or more value definition(s) with a selection predicate. | {"anyOf": [{}, {}, {"items": {}, "type": "array"}]} |
vega-lite.json | value | A constant value in visual domain. | {"type": ["number", "string", "boolean"]} |
vega-lite.json | TextValueDefWithCondition | A ValueDef with Condition<ValueDef | FieldDef>
{
condition: {field: ...} | {value: ...},
value: ...,
} | {"additionalProperties": false, "properties": {"condition": {"anyOf": [{}, {}, {"items": {}, "type": "array"}]}, "value": {"type": ["number", "string", "boolean"]}}, "type": "object"} |
vega-lite.json | condition | A field definition or one or more value definition(s) with a selection predicate. | {"anyOf": [{}, {}, {"items": {}, "type": "array"}]} |
vega-lite.json | value | A constant value in visual domain. | {"type": ["number", "string", "boolean"]} |
vega-lite.json | VgAxisBase | Base object for Vega's Axis and Axis Config.
All of these properties are both properties of Vega's Axis and Axis Config. | {"additionalProperties": false, "properties": {"domain": {"type": "boolean"}, "grid": {"type": "boolean"}, "labelAngle": {"maximum": 360, "minimum": -360, "type": "number"}, "labelBound": {"type": ["boolean", "number"]}, "labelFlush": {"type": ["boolean", "number"]}, "labelOverlap": {"anyOf": [{"type": "boolean"}, {"enum": ["parity"], "type": "string"}, {"enum": ["greedy"], "type": "string"}]}, "labelPadding": {"type": "number"}, "labels": {"type": "boolean"}, "maxExtent": {"type": "number"}, "minExtent": {"type": "number"}, "tickSize": {"minimum": 0, "type": "number"}, "ticks": {"type": "boolean"}, "titleMaxLength": {"type": "number"}, "titlePadding": {"type": "number"}}, "type": "object"} |
vega-lite.json | domain | A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.
__Default value:__ `true` | {"type": "boolean"} |
vega-lite.json | grid | A boolean flag indicating if grid lines should be included as part of the axis
__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`. | {"type": "boolean"} |
vega-lite.json | labelAngle | The rotation angle of the axis labels.
__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise. | {"maximum": 360, "minimum": -360, "type": "number"} |
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 | 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 | 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 | tickSize | The size in pixels of axis ticks. | {"minimum": 0, "type": "number"} |
vega-lite.json | ticks | Boolean value that determines whether the axis should include ticks. | {"type": "boolean"} |
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 | bandPosition | An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands. | {"type": "number"} |
vega-lite.json | domain | A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.
__Default value:__ `true` | {"type": "boolean"} |
vega-lite.json | domainColor | Color of axis domain line.
__Default value:__ (none, using Vega default). | {"type": "string"} |
vega-lite.json | domainWidth | Stroke width of axis domain line
__Default value:__ (none, using Vega default). | {"type": "number"} |
vega-lite.json | grid | A boolean flag indicating if grid lines should be included as part of the axis
__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`. | {"type": "boolean"} |
vega-lite.json | gridColor | Color of gridlines. | {"type": "string"} |
vega-lite.json | gridDash | The offset (in pixels) into which to begin drawing with the grid dash array. | {"items": {"type": "number"}, "type": "array"} |
vega-lite.json | gridOpacity | The stroke opacity of grid (value between [0,1])
__Default value:__ (`1` by default) | {"maximum": 1, "minimum": 0, "type": "number"} |
vega-lite.json | gridWidth | The grid width, in pixels. | {"minimum": 0, "type": "number"} |
vega-lite.json | labelAngle | The rotation angle of the axis labels.
__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise. | {"maximum": 360, "minimum": -360, "type": "number"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.