schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
vega-lite.json
size
Size of the box and mid tick of a box plot
{"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
box
Box Config
{}
vega-lite.json
fill
The fill color of the interval mark. __Default value:__ `#333333`
{"type": "string"}
vega-lite.json
fillOpacity
The fill opacity of the interval mark (a value between 0 and 1). __Default value:__ `0.125`
{"type": "number"}
vega-lite.json
stroke
The stroke color of the interval mark. __Default value:__ `#ffffff`
{"type": "string"}
vega-lite.json
strokeDash
An array of alternating stroke and space lengths, for creating dashed or dotted lines.
{"items": {"type": "number"}, "type": "array"}
vega-lite.json
strokeDashOffset
The offset (in pixels) with which to begin drawing the stroke dash array.
{"type": "number"}
vega-lite.json
strokeOpacity
The stroke opacity of the interval mark (a value between 0 and 1).
{"type": "number"}
vega-lite.json
strokeWidth
The stroke width of the interval mark.
{"type": "number"}
vega-lite.json
as
The field for storing the computed formula value.
{"type": "string"}
vega-lite.json
calculate
A string containing a Vega Expression. Use the variable `datum` to refer to the current data object.
{"type": "string"}
vega-lite.json
CompositeUnitSpec
Unit spec that can have a composite mark.
{}
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
selection
A [selection name](selection.html), or a series of [composed selections](selection.html#compose).
{}
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
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
selection
A [selection name](selection.html), or a series of [composed selections](selection.html#compose).
{}
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
selection
A [selection name](selection.html), or a series of [composed selections](selection.html#compose).
{}
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
area
Area-Specific Config
{}
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
axis
Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config).
{}
vega-lite.json
axisBand
Specific axis config for axes with "band" scales.
{}
vega-lite.json
axisBottom
Specific axis config for x-axis along the bottom edge of the chart.
{}
vega-lite.json
axisLeft
Specific axis config for y-axis along the left edge of the chart.
{}
vega-lite.json
axisRight
Specific axis config for y-axis along the right edge of the chart.
{}
vega-lite.json
axisTop
Specific axis config for x-axis along the top edge of the chart.
{}
vega-lite.json
axisX
X-axis specific config.
{}
vega-lite.json
axisY
Y-axis specific config.
{}
vega-lite.json
background
CSS color property to use as the background of visualization. __Default value:__ none (transparent)
{"type": "string"}
vega-lite.json
bar
Bar-Specific Config
{}
vega-lite.json
circle
Circle-Specific Config
{}
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
legend
Legend configuration, which determines default properties for all [legends](legend.html). For a full list of legend configuration options, please see the [corresponding section of in the legend documentation](legend.html#config).
{}
vega-lite.json
line
Line-Specific Config
{}
vega-lite.json
mark
Mark Config
{}
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
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
point
Point-Specific Config
{}
vega-lite.json
range
An object hash that defines default range arrays or schemes for using with scales. For a full list of scale range configuration options, please see the [corresponding section of the scale documentation](scale.html#config).
{}
vega-lite.json
rect
Rect-Specific Config
{}
vega-lite.json
rule
Rule-Specific Config
{}
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
square
Square-Specific Config
{}
vega-lite.json
stack
Default stack offset for stackable mark.
{}
vega-lite.json
style
An object hash that defines key-value mappings to determine default properties for marks with a given [style](mark.html#mark-def). The keys represent styles names; the value are valid [mark configuration objects](mark.html#config).
{}
vega-lite.json
text
Text-Specific Config
{}
vega-lite.json
tick
Tick-Specific Config
{}
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
title
Title configuration, which determines default properties for all [titles](title.html). For a full list of title configuration options, please see the [corresponding section of the title documentation](title.html#config).
{}
vega-lite.json
view
Default properties for [single view plots](spec.html#single).
{}
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": ["csv", "tsv"], "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.
{}
vega-lite.json
DateTime
Object for defining datetime in Vega-Lite Filter. If both month and quarter are provided, month has higher precedence. `day` cannot be combined with other date. We accept string for month and day names.
{"additionalProperties": false, "properties": {"date": {"maximum": 31, "minimum": 1, "type": "number"}, "day": {"anyOf": [{}, {"type": "string"}]}, "hours": {"maximum": 23, "minimum": 0, "type": "number"}, "milliseconds": {"maximum": 999, "minimum": 0, "type": "number"}, "minutes": {"maximum": 59, "minimum": 0, "type": "number"}, "month": {"anyOf": [{}, {"type": "string"}]}, "quarter": {"maximum": 4, "minimum": 1, "type": "number"}, "seconds": {"maximum": 59, "minimum": 0, "type": "number"}, "utc": {"type": "boolean"}, "year": {"type": "number"}}, "type": "object"}
vega-lite.json
date
Integer value representing the date from 1-31.
{"maximum": 31, "minimum": 1, "type": "number"}
vega-lite.json
day
Value representing the day of a week. This can be one of: (1) integer value -- `1` represents Monday; (2) case-insensitive day name (e.g., `"Monday"`); (3) case-insensitive, 3-character short day name (e.g., `"Mon"`). <br/> **Warning:** A DateTime definition object with `day`** should not be combined with `year`, `quarter`, `month`, or `date`.
{"anyOf": [{}, {"type": "string"}]}
vega-lite.json
hours
Integer value representing the hour of a day from 0-23.
{"maximum": 23, "minimum": 0, "type": "number"}
vega-lite.json
milliseconds
Integer value representing the millisecond segment of time.
{"maximum": 999, "minimum": 0, "type": "number"}
vega-lite.json
minutes
Integer value representing the minute segment of time from 0-59.
{"maximum": 59, "minimum": 0, "type": "number"}
vega-lite.json
month
One of: (1) integer value representing the month from `1`-`12`. `1` represents January; (2) case-insensitive month name (e.g., `"January"`); (3) case-insensitive, 3-character short month name (e.g., `"Jan"`).
{"anyOf": [{}, {"type": "string"}]}
vega-lite.json
quarter
Integer value representing the quarter of the year (from 1-4).
{"maximum": 4, "minimum": 1, "type": "number"}
vega-lite.json
seconds
Integer value representing the second segment (0-59) of a time value
{"maximum": 59, "minimum": 0, "type": "number"}
vega-lite.json
utc
A boolean flag indicating if date time is in utc time. If false, the date time is in local time
{"type": "boolean"}
vega-lite.json
year
Integer value representing the year.
{"type": "number"}
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
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
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": [{}, {}]}