Options

Paths are schema fields: mark.curve, mark.points, mark.area, axes.x.title. mark.markers and mark.fill are not fields. soft, refined, editorial, and midnight are real theme names.

spec.json200 · valid

Open the playground to edit a spec with validate, repair, and export.

Names that exist

mark.curve is monotone by default, or linear, step, step-before, step-after. mark.points is none, hover, or always. mark.area fills under a line. Axis titles are axes.x.title and axes.y.title.

Names that do not

mark.markers, mark.fill, and axis.x.label are not fields.

Schema options

615 options from the v1 schema. The playground builds its controls from this list. A value equal to the default is left out of the spec until you change it.

Data / Encoding

encoding.x
Horizontal position: time or category. For donut, the slice category. For heatmap calendar, the date. For bar with mark.orientation 'horizontal', it is still the category (drawn vertically).text · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +23
encoding.x.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density, histogram, scatter
encoding.x.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · line, bar, stacked-area, scatter, combo, histogram, boxplot, waterfall +8
encoding.x.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.decimals
Fixed number of fraction digits.number · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.currency
ISO 4217 code when style is 'currency'.text · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.prefix
Text placed before the value.text · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.suffix
Text placed after the value, e.g. ' req/s'.text · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.signed
Always show + for positive numbers (useful for deltas).boolean · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density
encoding.x.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on area-range, candlestick, density, histogram, spike, streamgraph
encoding.x.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3
encoding.x.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on area-range, candlestick, density, histogram, spike, streamgraph
encoding.x.scale.nice
Round the domain to tidy tick values. Default true.boolean · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on area-range, candlestick, density, histogram, scatter, spike, streamgraph
encoding.x.scale.reverse
Flip the direction of the scale.boolean · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density, histogram
encoding.x.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density, histogram, streamgraph
encoding.x.scale.padding.min
Fraction of the span added below the data.number · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density, histogram, streamgraph
encoding.x.scale.padding.max
Fraction of the span added above the data.number · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on density, histogram, streamgraph
encoding.x.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on area-range, candlestick, density, histogram, scatter, spike, streamgraph
encoding.x.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · line, stacked-area, scatter, combo, histogram, area-range, spike, candlestick +3Not yet on area-range, candlestick, density, histogram, scatter, spike, streamgraph
encoding.y
Measured value(s). One field, or a list of fields for multi-series 'wide' data (one column per series). For heatmap 'grid' layout, the row category.text · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +21Not yet on bar-range, tree
encoding.y.lo
Lower field of a range band. With hi, the series is a band. On a combo, set mark to range so the band sits under the other series.text · combo, area-range, bar-range, errorbarNot yet on area-range, bar-range, errorbar
encoding.y.hi
Upper field of a range band.text · combo, area-range, bar-range, errorbarNot yet on area-range, bar-range, errorbar
encoding.y.error
± field around this series. Half-width. Used by error bars when low and high are omitted.text · errorbarNot yet on errorbar
encoding.y.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, line, rose +3
encoding.y.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · line, bar, stacked-area, scatter, combo, boxplot, waterfall, area-range +6
encoding.y.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.decimals
Fixed number of fraction digits.number · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.currency
ISO 4217 code when style is 'currency'.text · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.prefix
Text placed before the value.text · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.suffix
Text placed after the value, e.g. ' req/s'.text · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.signed
Always show + for positive numbers (useful for deltas).boolean · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · line, bar, donut, pie, stacked-area, scatter, combo, boxplot +15Not yet on bar-range
encoding.y.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, rose, spike +1
encoding.y.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9
encoding.y.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, rose, spike +1
encoding.y.scale.nice
Round the domain to tidy tick values. Default true.boolean · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, line, rose +3
encoding.y.scale.reverse
Flip the direction of the scale.boolean · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, rose, spike +1
encoding.y.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on bullet, rose
encoding.y.scale.padding.min
Fraction of the span added below the data.number · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on bullet, rose
encoding.y.scale.padding.max
Fraction of the span added above the data.number · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on bullet, rose
encoding.y.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, line, rose +3
encoding.y.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · line, bar, stacked-area, scatter, combo, boxplot, radar, bullet +9Not yet on area-range, bar-range, boxplot, bullet, errorbar, histogram, line, rose +3
encoding.y.mark
Mark for this series. line, bar, and area are for combo. range draws a lo/hi band under the other combo series. A range series sets lo and hi instead of, or as well as, field.enum · combo
encoding.y.axis
Which y axis this series uses. The string "y" or "y2", not an axis object. 'y2' draws a second axis on the right. Put titles in axes.y.title or axes.y2.title.enum · default y · line, bar, stacked-area, scatter, combo
encoding.y.color
A CSS color ('#22c55e', 'rgb(...)', 'oklch(...)'), a CSS variable ('var(--chart-1)'), or a theme token reference: 'series-1'..'series-12', 'accent', 'positive', 'negative', 'text', 'muted', 'grid'.color · line, bar, stacked-area, scatter, comboNot yet on scatter
encoding.y.dash
Line style.enum · default solid · line, stacked-area, combo
encoding.y.area
Fill under this line (line/combo).boolean · line, combo
encoding.y.fillOpacity
Area or bar fill opacity for this series, 0–1. Overrides mark.fillOpacity.number · line, bar, stacked-area, comboNot yet on line
encoding.y.pointShape
Marker for this series. Overrides mark.pointShape. Applies to: line, stacked-area, scatter, combo.enum · line, stacked-area, scatter, combo
encoding.y.pointSize
Marker radius in px for this series. Overrides mark.pointSize.number · line, stacked-area, scatter, combo, errorbarNot yet on errorbar, scatter
encoding.y.pointFill
Filled or hollow marker for this series. Overrides mark.pointFill.enum · line, stacked-area, scatter, combo
encoding.y.stack
Stack group. Series that share this name stack together. A name used once draws that series unstacked. Omit it to follow mark.stack.text · line, bar, stacked-area, comboNot yet on line
encoding.y.z
Draw order. Higher paints later. Stacked series keep data order.number · line, bar, stacked-area, scatter, comboNot yet on line, scatter
encoding.series
Split 'long' data into series by the values of this field (e.g. region). Alternative to listing several y fields. Do not combine with a y array.text · line, bar, stacked-area, scatter, combo, heatmap, radar, pie +3Not yet on bar, combo, radar, scatter, stacked-area, streamgraph
encoding.series.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · line, bar, stacked-area, scatter, combo, heatmap, radar, pie +3Not yet on bar, combo, radar, scatter, stacked-area, streamgraph
encoding.color
Color by field or a constant. Heatmap: the value field. Scatter: category field. Defaults to series/theme palette.color · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +14Not yet on bar, combo, radar, stacked-area, streamgraph, timeline
encoding.color.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · scatter, heatmap, treemap, choropleth, map-pointsNot yet on heatmap
encoding.color.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +14Not yet on bar, combo, density, gantt, quadrant, radar, stacked-area, streamgraph +2
encoding.color.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.decimals
Fixed number of fraction digits.number · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.currency
ISO 4217 code when style is 'currency'.text · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.prefix
Text placed before the value.text · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.suffix
Text placed after the value, e.g. ' req/s'.text · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.signed
Always show + for positive numbers (useful for deltas).boolean · scatter, heatmap, treemap, choropleth, map-points
encoding.color.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.type
Position types match the shared scale. sequential, diverging, quantize, and threshold are colour-only and are not valid on x or y.enum · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.domain
Explicit [min, max] for a continuous colour scale.json · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.zero
Force the scale to include zero.boolean · scatter, heatmap, treemap, choropleth, map-pointsNot yet on heatmap
encoding.color.scale.nice
Round the domain to tidy values.boolean · scatter, heatmap, treemap, choropleth, map-pointsNot yet on heatmap
encoding.color.scale.reverse
Flip the direction of the scale.boolean · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.midpoint
Diverging midpoint. Default is the middle of the domain.number · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.scheme
Named colour-blind-safe ramp. blue is the default. A range of two or more colours replaces it. Midnight uses a brighter ramp of the same name.enum · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.bins
Equal-width bins for quantize. Default 5.number · scatter, heatmap, treemap, choropleth, map-points
encoding.color.scale.thresholds
Cut points for threshold. Colours are one more than the number of cuts. The legend labels the cuts, for example <6, 6–12, ≥12, not the data ends.json · scatter, heatmap, treemap, choropleth, map-points
encoding.color.range
Colors to use, in order (categorical) or low→high (sequential). Two or more colours replace a named scheme.json · scatter, heatmap, treemap, choropleth, map-points
encoding.color.domain
Category values in the same order as range. A value that is not listed takes the next palette colour.json · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +14
encoding.color.value
A CSS color ('#22c55e', 'rgb(...)', 'oklch(...)'), a CSS variable ('var(--chart-1)'), or a theme token reference: 'series-1'..'series-12', 'accent', 'positive', 'negative', 'text', 'muted', 'grid'.color · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +14Not yet on gantt, quadrant, radar, strip, timeline
encoding.size
Scatter only: bubble size field.text · scatter, quadrant, map-points
encoding.size.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.decimals
Fixed number of fraction digits.number · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.currency
ISO 4217 code when style is 'currency'.text · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.prefix
Text placed before the value.text · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.suffix
Text placed after the value, e.g. ' req/s'.text · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.signed
Always show + for positive numbers (useful for deltas).boolean · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · scatter, quadrant, map-points
encoding.size.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.nice
Round the domain to tidy tick values. Default true.boolean · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.reverse
Flip the direction of the scale.boolean · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.padding.min
Fraction of the span added below the data.number · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.padding.max
Fraction of the span added above the data.number · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · scatter, quadrant, map-pointsNot yet on quadrant, scatter
encoding.size.range
[min, max] point radius in px.json · scatter, quadrant, map-points
encoding.open
Candlestick only: opening price field.text · candlestick, gantt, timeline
encoding.open.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · candlestick, gantt, timeline
encoding.open.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · candlestick, gantt, timeline
encoding.open.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · candlestick, gantt, timeline
encoding.open.format.decimals
Fixed number of fraction digits.number · candlestick, gantt, timeline
encoding.open.format.currency
ISO 4217 code when style is 'currency'.text · candlestick, gantt, timeline
encoding.open.format.prefix
Text placed before the value.text · candlestick, gantt, timeline
encoding.open.format.suffix
Text placed after the value, e.g. ' req/s'.text · candlestick, gantt, timeline
encoding.open.format.signed
Always show + for positive numbers (useful for deltas).boolean · candlestick, gantt, timeline
encoding.open.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · candlestick, gantt, timeline
encoding.open.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · candlestick, gantt, timeline
encoding.open.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · candlestick, gantt, timeline
encoding.open.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · candlestick, gantt, timeline
encoding.open.scale.nice
Round the domain to tidy tick values. Default true.boolean · candlestick, gantt, timeline
encoding.open.scale.reverse
Flip the direction of the scale.boolean · candlestick, gantt, timeline
encoding.open.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · candlestick, gantt, timeline
encoding.open.scale.padding.min
Fraction of the span added below the data.number · candlestick, gantt, timeline
encoding.open.scale.padding.max
Fraction of the span added above the data.number · candlestick, gantt, timeline
encoding.open.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · candlestick, gantt, timeline
encoding.open.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · candlestick, gantt, timeline
encoding.high
Upper value. Candlestick: the high price. Area range, floating bar, and error bar: the top of the band or whisker.text · candlestick, area-range, bar-range, errorbar
encoding.high.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · candlestick, area-range, bar-range, errorbar
encoding.high.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · candlestick, area-range, bar-range, errorbar
encoding.high.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · candlestick, area-range, bar-range, errorbar
encoding.high.format.decimals
Fixed number of fraction digits.number · candlestick, area-range, bar-range, errorbar
encoding.high.format.currency
ISO 4217 code when style is 'currency'.text · candlestick, area-range, bar-range, errorbar
encoding.high.format.prefix
Text placed before the value.text · candlestick, area-range, bar-range, errorbar
encoding.high.format.suffix
Text placed after the value, e.g. ' req/s'.text · candlestick, area-range, bar-range, errorbar
encoding.high.format.signed
Always show + for positive numbers (useful for deltas).boolean · candlestick, area-range, bar-range, errorbar
encoding.high.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · candlestick, area-range, bar-range, errorbar
encoding.high.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · candlestick, area-range, bar-range, errorbar
encoding.high.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · candlestick, area-range, bar-range, errorbar
encoding.high.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · candlestick, area-range, bar-range, errorbar
encoding.high.scale.nice
Round the domain to tidy tick values. Default true.boolean · candlestick, area-range, bar-range, errorbar
encoding.high.scale.reverse
Flip the direction of the scale.boolean · candlestick, area-range, bar-range, errorbar
encoding.high.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · candlestick, area-range, bar-range, errorbar
encoding.high.scale.padding.min
Fraction of the span added below the data.number · candlestick, area-range, bar-range, errorbar
encoding.high.scale.padding.max
Fraction of the span added above the data.number · candlestick, area-range, bar-range, errorbar
encoding.high.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · candlestick, area-range, bar-range, errorbar
encoding.high.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · candlestick, area-range, bar-range, errorbar
encoding.low
Lower value. Candlestick: the low price. Area range, floating bar, and error bar: the bottom of the band or whisker.text · candlestick, area-range, bar-range, errorbar
encoding.low.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · candlestick, area-range, bar-range, errorbar
encoding.low.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · candlestick, area-range, bar-range, errorbar
encoding.low.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · candlestick, area-range, bar-range, errorbar
encoding.low.format.decimals
Fixed number of fraction digits.number · candlestick, area-range, bar-range, errorbar
encoding.low.format.currency
ISO 4217 code when style is 'currency'.text · candlestick, area-range, bar-range, errorbar
encoding.low.format.prefix
Text placed before the value.text · candlestick, area-range, bar-range, errorbar
encoding.low.format.suffix
Text placed after the value, e.g. ' req/s'.text · candlestick, area-range, bar-range, errorbar
encoding.low.format.signed
Always show + for positive numbers (useful for deltas).boolean · candlestick, area-range, bar-range, errorbar
encoding.low.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · candlestick, area-range, bar-range, errorbar
encoding.low.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · candlestick, area-range, bar-range, errorbar
encoding.low.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · candlestick, area-range, bar-range, errorbar
encoding.low.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · candlestick, area-range, bar-range, errorbar
encoding.low.scale.nice
Round the domain to tidy tick values. Default true.boolean · candlestick, area-range, bar-range, errorbar
encoding.low.scale.reverse
Flip the direction of the scale.boolean · candlestick, area-range, bar-range, errorbar
encoding.low.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · candlestick, area-range, bar-range, errorbar
encoding.low.scale.padding.min
Fraction of the span added below the data.number · candlestick, area-range, bar-range, errorbar
encoding.low.scale.padding.max
Fraction of the span added above the data.number · candlestick, area-range, bar-range, errorbar
encoding.low.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · candlestick, area-range, bar-range, errorbar
encoding.low.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · candlestick, area-range, bar-range, errorbar
encoding.close
Candlestick only: closing price field.text · candlestick, gantt, timeline
encoding.close.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · candlestick, gantt, timeline
encoding.close.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · candlestick, gantt, timeline
encoding.close.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · candlestick, gantt, timeline
encoding.close.format.decimals
Fixed number of fraction digits.number · candlestick, gantt, timeline
encoding.close.format.currency
ISO 4217 code when style is 'currency'.text · candlestick, gantt, timeline
encoding.close.format.prefix
Text placed before the value.text · candlestick, gantt, timeline
encoding.close.format.suffix
Text placed after the value, e.g. ' req/s'.text · candlestick, gantt, timeline
encoding.close.format.signed
Always show + for positive numbers (useful for deltas).boolean · candlestick, gantt, timeline
encoding.close.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · candlestick, gantt, timeline
encoding.close.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · candlestick, gantt, timeline
encoding.close.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · candlestick, gantt, timeline
encoding.close.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · candlestick, gantt, timeline
encoding.close.scale.nice
Round the domain to tidy tick values. Default true.boolean · candlestick, gantt, timeline
encoding.close.scale.reverse
Flip the direction of the scale.boolean · candlestick, gantt, timeline
encoding.close.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · candlestick, gantt, timeline
encoding.close.scale.padding.min
Fraction of the span added below the data.number · candlestick, gantt, timeline
encoding.close.scale.padding.max
Fraction of the span added above the data.number · candlestick, gantt, timeline
encoding.close.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · candlestick, gantt, timeline
encoding.close.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · candlestick, gantt, timeline
encoding.volume
Candlestick only: volume field. When set, bars are drawn under the price plot.text · candlestick
encoding.volume.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · candlestick
encoding.volume.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · candlestick
encoding.volume.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · candlestick
encoding.volume.format.decimals
Fixed number of fraction digits.number · candlestick
encoding.volume.format.currency
ISO 4217 code when style is 'currency'.text · candlestick
encoding.volume.format.prefix
Text placed before the value.text · candlestick
encoding.volume.format.suffix
Text placed after the value, e.g. ' req/s'.text · candlestick
encoding.volume.format.signed
Always show + for positive numbers (useful for deltas).boolean · candlestick
encoding.volume.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · candlestick
encoding.volume.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · candlestick
encoding.volume.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · candlestick
encoding.volume.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · candlestick
encoding.volume.scale.nice
Round the domain to tidy tick values. Default true.boolean · candlestick
encoding.volume.scale.reverse
Flip the direction of the scale.boolean · candlestick
encoding.volume.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · candlestick
encoding.volume.scale.padding.min
Fraction of the span added below the data.number · candlestick
encoding.volume.scale.padding.max
Fraction of the span added above the data.number · candlestick
encoding.volume.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · candlestick
encoding.volume.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · candlestick
encoding.source
Sankey only: the node the flow leaves.text · sankey, gantt
encoding.source.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · sankey, ganttNot yet on gantt, sankey
encoding.source.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · sankey, ganttNot yet on gantt, sankey
encoding.source.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · sankey, ganttNot yet on gantt, sankey
encoding.source.format.decimals
Fixed number of fraction digits.number · sankey, ganttNot yet on gantt, sankey
encoding.source.format.currency
ISO 4217 code when style is 'currency'.text · sankey, ganttNot yet on gantt, sankey
encoding.source.format.prefix
Text placed before the value.text · sankey, ganttNot yet on gantt, sankey
encoding.source.format.suffix
Text placed after the value, e.g. ' req/s'.text · sankey, ganttNot yet on gantt, sankey
encoding.source.format.signed
Always show + for positive numbers (useful for deltas).boolean · sankey, ganttNot yet on gantt, sankey
encoding.source.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · sankey, gantt
encoding.source.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.nice
Round the domain to tidy tick values. Default true.boolean · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.reverse
Flip the direction of the scale.boolean · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.padding.min
Fraction of the span added below the data.number · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.padding.max
Fraction of the span added above the data.number · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · sankey, ganttNot yet on gantt, sankey
encoding.source.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · sankey, ganttNot yet on gantt, sankey
encoding.target
Sankey: the node the flow enters. Bullet: the target value field.text · sankey, bullet, gantt
encoding.target.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.decimals
Fixed number of fraction digits.number · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.currency
ISO 4217 code when style is 'currency'.text · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.prefix
Text placed before the value.text · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.suffix
Text placed after the value, e.g. ' req/s'.text · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.signed
Always show + for positive numbers (useful for deltas).boolean · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · sankey, bullet, ganttNot yet on gantt, sankey
encoding.target.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · sankey, bullet, gantt
encoding.target.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.nice
Round the domain to tidy tick values. Default true.boolean · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.reverse
Flip the direction of the scale.boolean · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.padding.min
Fraction of the span added below the data.number · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.padding.max
Fraction of the span added above the data.number · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.target.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · sankey, bullet, ganttNot yet on bullet, gantt, sankey
encoding.error
Error bar only: symmetric ± around y. The field is the half-width. encoding.low and encoding.high override it.text · errorbarNot yet on errorbar
encoding.error.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · errorbarNot yet on errorbar
encoding.error.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · errorbarNot yet on errorbar
encoding.error.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · errorbarNot yet on errorbar
encoding.error.format.decimals
Fixed number of fraction digits.number · errorbarNot yet on errorbar
encoding.error.format.currency
ISO 4217 code when style is 'currency'.text · errorbarNot yet on errorbar
encoding.error.format.prefix
Text placed before the value.text · errorbarNot yet on errorbar
encoding.error.format.suffix
Text placed after the value, e.g. ' req/s'.text · errorbarNot yet on errorbar
encoding.error.format.signed
Always show + for positive numbers (useful for deltas).boolean · errorbarNot yet on errorbar
encoding.error.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · errorbarNot yet on errorbar
encoding.error.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · errorbarNot yet on errorbar
encoding.error.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · errorbar
encoding.error.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · errorbarNot yet on errorbar
encoding.error.scale.nice
Round the domain to tidy tick values. Default true.boolean · errorbarNot yet on errorbar
encoding.error.scale.reverse
Flip the direction of the scale.boolean · errorbarNot yet on errorbar
encoding.error.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · errorbar
encoding.error.scale.padding.min
Fraction of the span added below the data.number · errorbar
encoding.error.scale.padding.max
Fraction of the span added above the data.number · errorbar
encoding.error.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · errorbarNot yet on errorbar
encoding.error.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · errorbarNot yet on errorbar
encoding.path
Treemap and sunburst: field names from the root down to the leaf, for flat rows. A parent with no value is the sum of its leaves.json · treemap, sunburst, tree
encoding.id
Treemap and sunburst: the node id field. Pair it with encoding.parent.text · treemap, sunburst, treeNot yet on treemap
encoding.parent
Treemap and sunburst: the parent id field. An empty parent is a root. On a treemap with no encoding.id, a legacy parent field still repairs to encoding.color.text · treemap, sunburst, treeNot yet on treemap
encoding.label
Strip only: field shown with the group and the value in the point tooltip. It is not drawn on the plot. Other chart types warn CK3094.text · stripNot yet on strip
encoding.label.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · stripNot yet on strip
encoding.label.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · stripNot yet on strip
encoding.label.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · stripNot yet on strip
encoding.label.format.decimals
Fixed number of fraction digits.number · stripNot yet on strip
encoding.label.format.currency
ISO 4217 code when style is 'currency'.text · stripNot yet on strip
encoding.label.format.prefix
Text placed before the value.text · stripNot yet on strip
encoding.label.format.suffix
Text placed after the value, e.g. ' req/s'.text · stripNot yet on strip
encoding.label.format.signed
Always show + for positive numbers (useful for deltas).boolean · stripNot yet on strip
encoding.label.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · stripNot yet on strip
encoding.label.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · stripNot yet on strip
encoding.label.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · strip
encoding.label.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · stripNot yet on strip
encoding.label.scale.nice
Round the domain to tidy tick values. Default true.boolean · stripNot yet on strip
encoding.label.scale.reverse
Flip the direction of the scale.boolean · stripNot yet on strip
encoding.label.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · stripNot yet on strip
encoding.label.scale.padding.min
Fraction of the span added below the data.number · stripNot yet on strip
encoding.label.scale.padding.max
Fraction of the span added above the data.number · stripNot yet on strip
encoding.label.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · stripNot yet on strip
encoding.label.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · stripNot yet on strip
encoding.note
Strip only: a second, smaller line under the category label. Every point in the group should carry the same note, such as 100k points. The label and the note stay centred on that group's line. Other chart types warn CK3135.text · All charts
encoding.note.type
Measurement type of the field. Inferred from data if omitted: numbers→quantitative, ISO date strings/epoch ms on x→temporal, other strings→nominal.enum · All charts
encoding.note.title
Human-readable name used in axes, legend and tooltip. Defaults to the field name.text · All charts
encoding.note.format
How values are displayed in axes, tooltips and labels. A preset string, or an object for fine control. Formatting uses Intl with the spec 'locale'.enum · All charts
encoding.note.format.decimals
Fixed number of fraction digits.number · All charts
encoding.note.format.currency
ISO 4217 code when style is 'currency'.text · All charts
encoding.note.format.prefix
Text placed before the value.text · All charts
encoding.note.format.suffix
Text placed after the value, e.g. ' req/s'.text · All charts
encoding.note.format.signed
Always show + for positive numbers (useful for deltas).boolean · All charts
encoding.note.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · All charts
encoding.note.scale.type
Scale type. Inferred from field type: quantitative→linear, temporal→time, nominal/ordinal→band. symlog is a signed log that passes through zero.enum · All charts
encoding.note.scale.domain
Explicit [min, max] for continuous scales, or the ordered list of categories for band/point scales. Use null for one side to keep it automatic.json · All charts
encoding.note.scale.zero
Force the scale to include zero. Default true for bar/area, false for line/scatter.boolean · All charts
encoding.note.scale.nice
Round the domain to tidy tick values. Default true.boolean · All charts
encoding.note.scale.reverse
Flip the direction of the scale.boolean · All charts
encoding.note.scale.padding
Extra room past the data, as a fraction of the span. A number pads both ends. An object pads one end. 0.08 is eight percent. An explicit domain end stays as set.number · All charts
encoding.note.scale.padding.min
Fraction of the span added below the data.number · All charts
encoding.note.scale.padding.max
Fraction of the span added above the data.number · All charts
encoding.note.scale.clamp
Draw values outside an explicit scale.domain at the domain edge.boolean · All charts
encoding.note.scale.constant
Linear half-width of a symlog scale, in data units. Default 1. Ignored unless type is symlog.number · All charts
metric.value
The current value.number · gauge, kpi, progress-ring
metric.label
Short visible label, e.g. 'Revenue'.text · gauge, kpi, progress-ring
metric.min
Lower bound of the scale (gauge, progress-ring).number · default 0 · gauge, kpi, progress-ring
metric.max
Upper bound of the scale (gauge, progress-ring).number · default 100 · gauge, kpi, progress-ring
metric.target
Target marker value (gauge) or comparison value.number · gauge, kpi, progress-ring
metric.delta
Change vs previous period, as a fraction (0.125 = +12.5%) unless deltaFormat says otherwise (kpi).number · gauge, kpi, progress-ring
metric.deltaFormat
Format for delta. Default 'percent' with signed: true.enum · gauge, kpi, progress-ring
metric.deltaFormat.decimals
Fixed number of fraction digits.number · gauge, kpi, progress-ring
metric.deltaFormat.currency
ISO 4217 code when style is 'currency'.text · gauge, kpi, progress-ring
metric.deltaFormat.prefix
Text placed before the value.text · gauge, kpi, progress-ring
metric.deltaFormat.suffix
Text placed after the value, e.g. ' req/s'.text · gauge, kpi, progress-ring
metric.deltaFormat.signed
Always show + for positive numbers (useful for deltas).boolean · gauge, kpi, progress-ring
metric.deltaFormat.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · gauge, kpi, progress-ring
metric.goodDirection
Which direction of delta is good (sets positive/negative color).enum · default up · gauge, kpi, progress-ring
metric.format
Format for value.enum · gauge, kpi, progress-ring
metric.format.decimals
Fixed number of fraction digits.number · gauge, kpi, progress-ringNot yet on gauge
metric.format.currency
ISO 4217 code when style is 'currency'.text · gauge, kpi, progress-ringNot yet on gauge, kpi
metric.format.prefix
Text placed before the value.text · gauge, kpi, progress-ring
metric.format.suffix
Text placed after the value, e.g. ' req/s'.text · gauge, kpi, progress-ring
metric.format.signed
Always show + for positive numbers (useful for deltas).boolean · gauge, kpi, progress-ring
metric.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · gauge, kpi, progress-ring
metric.bands
Colored ranges on the gauge, e.g. good/warn/bad.json · gauge, kpi, progress-ring
metric.thresholds
Colour the kpi surface from the value. The last step at or below metric.value wins. Applies to: kpi.json · gauge, kpi, progress-ring

Marks & style

mark.curve
Line interpolation. monotone is monotone-x and stays inside the data, so a spike does not cross the low point or pass the peak. smooth, spline, and basis repair to monotone.enum · default monotone · line, stacked-area, combo, sparkline, mini-area, streamgraph
mark.sampling
Downsample the path when a series is longer than twice the plot width in pixels. 'auto' and 'minmax' keep the minimum and maximum original point in each pixel bucket (spikes stay).enum · default auto · line, stacked-area, combo, sparkline, mini-area, spikeNot yet on combo, line, mini-area, sparkline, spike, stacked-area
mark.points
Show point markers on lines. Applies to: line, combo.enum · default hover · line, combo
mark.track
Ranked-row track. bar is a short rounded bar. row is a full-height wash behind the label, width proportional to the value, with the count on the right. Applies to: bar-list.enum · default bar · bar-list
mark.pointSize
Point radius in px. Applies to: line, stacked-area, combo, scatter, errorbar, strip.number · line, stacked-area, combo, scatter, errorbar, stripNot yet on scatter
mark.pointShape
Point marker. circle, square, diamond, triangle, cross, or none. A y series may override it. Applies to: line, stacked-area, scatter, combo. Drawn on createRenderer([line]).enum · line, stacked-area, scatter, combo
mark.pointFill
Filled or hollow markers. Applies to: line, stacked-area, scatter, combo.enum · line, stacked-area, scatter, combo
mark.area
Fill under every line. Applies to: line, sparkline.boolean · line, sparkline
mark.fillOpacity
Area/bar fill opacity, 0–1. Applies to: line, stacked-area, combo, mini-area, bar, streamgraph. A streamgraph defaults to 0.22.number · line, stacked-area, combo, mini-area, bar, streamgraph, density
mark.gradient
Fade area fills toward the baseline. Applies to: line, stacked-area, mini-area, sparkline.boolean · default true · line, stacked-area, mini-area, sparkline
mark.strokeWidth
Line width in px. Applies to: line, stacked-area, combo, sparkline, mini-area, spike, progress-ring, gauge (arc width), streamgraph.number · line, stacked-area, combo, sparkline, mini-area, spike, progress-ring, gauge +2
mark.glow
Soft glow behind the line. A blurred understroke and one filter, emitted only when true, on Soft and on midnight. Applies to: line, sparkline, combo.boolean · default false · line, sparkline, combo
mark.connectNulls
Draw through missing values instead of leaving gaps. Applies to: line, stacked-area, combo, sparkline, mini-area, streamgraph.boolean · default false · line, stacked-area, combo, sparkline, mini-area, streamgraphNot yet on combo, line, mini-area, sparkline, stacked-area, streamgraph
mark.stack
Stacking for multiple series. 'percent' normalises each x to 100%. Applies to: bar, stacked-area (default 'stack'), combo bars, radial-bar, rose. On a polar chart, none groups the sectors and stack or percent runs outward from the hole.enum · bar, stacked-area, combo, radial-bar, rose
mark.streamOffset
Streamgraph baseline. wiggle minimizes layer-to-layer movement and is the default. center, also called silhouette, centers each column on zero. zero stacks on the axis. expand draws shares that sum to 1. One series repairs to zero.enum · default wiggle · streamgraph
mark.order
Streamgraph layer order. Omitted means inside-out when the baseline is wiggle, and first-seen order otherwise. inside-out puts the smallest series in the middle. ascending and descending sort by the series sum.enum · streamgraph
mark.orientation
Bar direction. vertical is the bar default. Strip treats an omission as horizontal: categories run down the y axis and the numeric axis is x. Set vertical to swap them.enum · default vertical · bar, strip, densityNot yet on density
mark.cornerRadius
Rounded corners in px. Applies to: bar, donut, pie, heatmap, radial-bar, rose. A radial bar rounds the outer end.number · bar, donut, pie, heatmap, histogram, boxplot, treemap, sankey +4Not yet on boxplot, bullet, histogram, rose, sankey, treemap, waterfall
mark.gap
Spacing between bars/cells as a 0–1 fraction of the band. Applies to: bar, combo, heatmap, candlestick, radial-bar, rose. On a grouped polar chart it is the share of the category left between series.number · bar, combo, heatmap, candlestick, histogram, boxplot, funnel, treemap +3Not yet on histogram, rose, treemap
mark.stackGap
Pixel gap between stacked segments. Applies to: bar, stacked-area, combo.number · bar, stacked-area, combo
mark.radiusEnds
Which bar corners round. outer rounds the end away from the baseline. all rounds every corner. Applies to: bar.enum · bar
mark.partial
Dash the last segment only. The area still covers the whole series, including that segment. Applies to: line, stacked-area, combo.enum · line, stacked-area, combo
mark.partialOpacity
Fill opacity of the last area segment. The earlier area keeps mark.fillOpacity. Applies to: line, stacked-area, combo.number · line, stacked-area, combo
mark.innerRadius
Hole size as a 0–0.95 fraction of the radius. Donut defaults to 0.6. Pie defaults to 0. Sunburst uses 0.28 when this is omitted. Radial-bar defaults to 0.34. Rose defaults to 0. Above 0.85 on a polar chart warns CK3075.number · default 0.6 · donut, pie, sunburst, radial-bar, rose
mark.tree
tidy is Reingold–Tilford. cluster lines the leaves up, which is the dendrogram. Applies to: tree.enum · default tidy · tree
mark.orient
Root on the left, right, top, or bottom. Applies to: tree.enum · default LR · tree
mark.radial
Root at the center and depth as the radius. Applies to: tree.boolean · default false · tree
mark.colorBy
Color dots by the top-level branch or by depth. encoding.color wins when it names a field. Applies to: tree.enum · default branch · tree
mark.collapsed
Ids of nodes whose children are hidden. A click in mount() toggles an id. The static SVG uses this list. Applies to: tree.json · tree
mark.depth
How many levels to draw under the root. Deeper nodes fold into that level. Default 8. Applies to: treemap, sunburst, tree.number · treemap, sunburst, treeNot yet on tree, treemap
mark.padAngle
Gap between slices in degrees. Donut defaults to 2. Pie defaults to 0. Radial-bar defaults to 2. Rose defaults to 1.2. Above 8 degrees on a polar chart warns CK3076. Applies to: donut, pie, radial-bar, rose.number · donut, pie, radial-bar, rose
mark.summary
Tick drawn across each group. median is the default. mean is the arithmetic mean. none draws no tick. A strip where every group has one point hides the tick. Applies to: strip.enum · default median · strip
mark.band
Bar behind the dots. none draws none. range runs from the minimum to the maximum. iqr runs from the first quartile to the third. A group with fewer than 3 points draws no band. Applies to: strip.enum · default none · strip
mark.jitter
Spread dots that share a position. auto offsets a dot only when another dot in the group is within one diameter. none never offsets. A number is the maximum offset in px and moves every dot.enum · default auto · stripNot yet on strip
mark.highlight
Group or series value to emphasise. A group name marks that row. A series value, the color field, marks those dots. With mark.emphasis omitted or muted, the other marks use muted. Applies to: strip.text · strip
mark.emphasis
How mark.highlight is drawn. muted fades every other mark. ring draws the highlighted dots larger, with a ring, and keeps the other series colours. color paints the highlighted row in accent and keeps the other series colours.enum · strip
mark.note
Second line under the category label. none draws none. field uses encoding.note. range draws the minimum and maximum and does not repeat them beside the end label. The two lines stay centred on the plotted line. Applies to: strip.enum · default none · strip
mark.notePrefix
Text before the note, such as range followed by a space. Applies to: strip.text · strip
mark.pin
A value outside scale.domain is an edge marker with its real value, not a dot past the plot. Needs an explicit domain. Applies to: strip.boolean · default false · strip
mark.pinFormat
Format for a pin label. Defaults to mark.labelFormat, then the axis format. duration-ms prints 18.7 s. Applies to: strip.enum · strip
mark.pinFormat.decimals
Fixed number of fraction digits.number · strip
mark.pinFormat.currency
ISO 4217 code when style is 'currency'.text · strip
mark.pinFormat.prefix
Text placed before the value.text · strip
mark.pinFormat.suffix
Text placed after the value, e.g. ' req/s'.text · strip
mark.pinFormat.signed
Always show + for positive numbers (useful for deltas).boolean · strip
mark.pinFormat.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · strip
mark.bandColor
Fill of the range band. accent is one wash. series uses that row's colour at low opacity. Applies to: strip.enum · default accent · strip
mark.value
Number at the end of the row. summary is the median, the mean, or the first point when the tick is hidden. highlight is the highlighted series value in that row. Applies to: strip.enum · default summary · strip
mark.labelColor
Colour of the end label. text is ink. accent is the brand colour. series uses that row's colour, and a highlighted row stays accent. Applies to: strip.enum · default text · strip
mark.labelSuffix
Smaller unit after the end label, such as ms or tok. It is not part of the tick format. Applies to: strip.text · strip
mark.zebra
Tint every other row, starting with the first. The tint sits behind the line. It is not a rule between rows. Applies to: strip.boolean · default false · strip
mark.gutter
Right margin for the end label, in px. Omitted, the margin fits the labels. A set value wins over that fit. size.width and size.height are never changed. Applies to: strip.number · strip
mark.sort
Slice order. none keeps data order and pins an Other bucket last. asc and desc sort by value, including Other.enum · default none · donut, pie, strip
mark.other
Group small slices into one Other slice. A number is the fraction. Applies to: donut, pie.number · donut, pieNot yet on donut
mark.other.label
Name of the folded slice. Default Other.text · donut, pieNot yet on donut
mark.offset
Pull slices out from the centre, in px. With mark.explode, only those slices move. Otherwise every slice moves. Applies to: donut, pie.number · donut, pie
mark.explode
Slice names to offset. Uses mark.offset, or 12px when offset is omitted. Applies to: donut, pie.json · donut, pie
mark.opacity
Mark opacity 0–1. Applies to: scatter, spike.number · scatter, spikeNot yet on spike
mark.layout
Heatmap layout. Omit it when encoding.y is set: the renderer uses grid. 'calendar' = weeks by weekdays from a date x (also the fallback when y is absent). 'grid' = x by y categories. Applies to: heatmap.enum · default calendar · heatmap
mark.weeks
Number of weeks shown in calendar layout, ending on the week of the latest day. Ignored on a grid heatmap. Cells stay square, or at most 1.5:1, and cap at 32px. Extra width centres the grid. Unsized calendars stay at 12px.number · default 52 · heatmap
mark.startAngle
Arc start in degrees (0 = top, clockwise). Applies to: gauge, progress-ring, donut, pie, radial-bar, rose. Polar charts start at 0, the top of the circle.number · gauge, progress-ring, donut, pie, radial-bar, rose
mark.endAngle
Arc end in degrees. Applies to: gauge, progress-ring.number · gauge, progress-ring
mark.linecap
Arc end style. Applies to: gauge, progress-ring.enum · default round · gauge, progress-ring
mark.rings
Concentric activity rings, outer first. Each item is {value, max, color, label}. Applies to: progress-ring.json · progress-ring
mark.baseline
Value spikes rise from. Applies to: spike.number · default 0 · spike
mark.shape
Funnel geometry. trapezoid is the default: each stage shares its bottom edge with the next stage and the width tapers with the value. bar draws centered rounded bars. Applies to: funnel.enum · default trapezoid · funnel
mark.bins
Histogram bin count when mark.bin is count or omitted. Default 8. Applies to: histogram. A density warns CK3107 and repair removes it.number · histogram
mark.bin
Histogram bin rule. count uses mark.bins. width uses mark.binWidth. sturges, sqrt, and fd choose a count from the data. Applies to: histogram.enum · histogram
mark.binWidth
Histogram bin width. Used when mark.bin is width. Applies to: histogram.number · histogramNot yet on histogram
mark.bandwidth
Gaussian kernel width in data units. auto is Scott's rule, 1.06 times the standard deviation times n to the power -1/5. A number must be greater than 0. Other chart types warn CK3111. Applies to: density.text · density
mark.steps
Samples along the density curve. Default 64. Other chart types warn CK3112. Applies to: density.number · default 64 · density
mark.extent
Domain of the density curve. pad extends the sample by 3 bandwidths. data clips to the sample. A pair is the domain. Applies to: density.enum · density
mark.normalize
density integrates to 1. count multiplies by the sample size. Applies to: density.enum · default density · density
mark.dims
1 is the kernel curve. 2 is not available yet and is CK3109. Applies to: density.enum · densityNot yet on density
mark.rug
Draw a tick for each raw sample on the baseline. Applies to: density.boolean · default false · density
mark.ranges
Bullet band fields, worst to best. Each value is the upper edge of that band. Applies to: bullet.json · bullet
mark.total
Waterfall field that marks an absolute total when the row is true. Default field name total. Applies to: waterfall.text · waterfall
mark.line
Centre line through encoding.y on a range area. Defaults on when y is set. false draws the band only. Applies to: area-range.boolean · area-rangeNot yet on area-range
mark.stroke
Outline a range band. Off by default so a nested interval stays a fill in the line colour. Applies to: area-range.boolean · default false · area-range
mark.strokeDash
Dash the centre line where a band is present, and keep the earlier actuals solid. Both parts use the line colour. Applies to: area-range.boolean · default false · area-range
mark.error
Whisker anchor. point draws a marker at y. bar draws a bar from zero to y. Applies to: errorbar.enum · errorbar

Axes

axes.x
Axis options. Set to false to hide the axis.boolean · default true · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on strip
axes.x.title
Axis title. Defaults to the channel title (none for time axes).text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.format
Tick label format. Defaults to the channel format. On a strip this formats the ticks only. The row end label uses mark.labelFormat.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.decimals
Fixed number of fraction digits.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.currency
ISO 4217 code when style is 'currency'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.prefix
Text placed before the value.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.suffix
Text placed after the value, e.g. ' req/s'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.signed
Always show + for positive numbers (useful for deltas).boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.edgeLabel
Label drawn at the high end of the axis, such as 5s+. It does not move the domain. Applies to: strip.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.ticks
Approximate tick count, the exact tick values, or "ends" for the first and last label only.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.grid
Grid lines from this axis.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter
axes.x.position
Axis side. Defaults: x bottom, y left, y2 right. A side perpendicular to the axis maps onto the nearer end.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, streamgraph
axes.x.titlePosition
Where the title sits along the axis. start is the minimum end (left or bottom). end is the maximum end. Default center.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.titleRotate
Axis title rotation in degrees. Default 0 on x, -90 on a left y axis, and 90 on a right y or y2 axis.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.autoSkip
Skip tick labels that would overlap. false draws every label. When omitted, crowded category labels still tilt about -40 degrees if that fits, and numeric ticks skip only when they collide.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on bar, bar-range, boxplot, candlestick, combo, errorbar, line, spike +4
axes.x.labelWidth
Maximum tick-label width in pixels. Longer labels wrap, then ellipsize.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.x.labelLines
Maximum lines for a wrapped tick label. Enables wrapping at 72 pixels when labelWidth is omitted.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.x.line
Axis baseline. Off unless set. Color defaults to the axis token.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.line.color
Stroke color. Defaults to the axis token.color · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.line.width
Stroke width in pixels.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.line.dash
Stroke pattern.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.tickMarks
Tick marks at labeled ticks. none is the default. inside points into the plot.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.tickLength
Tick mark length in pixels. Setting it draws outside marks unless tickMarks says otherwise.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.rotate
Tick label rotation in degrees. When omitted, crowded category labels rotate about -40 degrees unless autoSkip is true.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.offset
Shift the baseline outward in pixels. Positive moves it away from the plot.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.x.crosses
Data value where this axis crosses the other. 0 draws the axis through zero.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.x.minorTicks
Minor tick marks between major ticks. 0 hides them.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.x.breaks
Ranges collapsed to a short gap. The break mark is drawn on the axis. When the segment below crosses zero, share is the fraction of the axis from zero to the break (default 0.4); otherwise share is the fraction for that whole segment.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.x.bands
Shaded x ranges, or "weekends" to shade Saturday and Sunday when x is dates.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y
Axis options. Set to false to hide the axis.boolean · default true · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.title
Axis title. Defaults to the channel title (none for time axes).text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.format
Tick label format. Defaults to the channel format. On a strip this formats the ticks only. The row end label uses mark.labelFormat.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.y.format.decimals
Fixed number of fraction digits.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.format.currency
ISO 4217 code when style is 'currency'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on bar-range, density
axes.y.format.prefix
Text placed before the value.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.y.format.suffix
Text placed after the value, e.g. ' req/s'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.format.signed
Always show + for positive numbers (useful for deltas).boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.y.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density
axes.y.edgeLabel
Label drawn at the high end of the axis, such as 5s+. It does not move the domain. Applies to: strip.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.ticks
Approximate tick count, the exact tick values, or "ends" for the first and last label only.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.grid
Grid lines from this axis.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.position
Axis side. Defaults: x bottom, y left, y2 right. A side perpendicular to the axis maps onto the nearer end.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, streamgraph
axes.y.titlePosition
Where the title sits along the axis. start is the minimum end (left or bottom). end is the maximum end. Default center.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.titleRotate
Axis title rotation in degrees. Default 0 on x, -90 on a left y axis, and 90 on a right y or y2 axis.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.autoSkip
Skip tick labels that would overlap. false draws every label. When omitted, crowded category labels still tilt about -40 degrees if that fits, and numeric ticks skip only when they collide.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar, bar-range, boxplot, candlestick, combo, density, errorbar +8
axes.y.labelWidth
Maximum tick-label width in pixels. Longer labels wrap, then ellipsize.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.y.labelLines
Maximum lines for a wrapped tick label. Enables wrapping at 72 pixels when labelWidth is omitted.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.y.line
Axis baseline. Off unless set. Color defaults to the axis token.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.line.color
Stroke color. Defaults to the axis token.color · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.line.width
Stroke width in pixels.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.line.dash
Stroke pattern.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.tickMarks
Tick marks at labeled ticks. none is the default. inside points into the plot.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.tickLength
Tick mark length in pixels. Setting it draws outside marks unless tickMarks says otherwise.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.rotate
Tick label rotation in degrees. When omitted, crowded category labels rotate about -40 degrees unless autoSkip is true.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.offset
Shift the baseline outward in pixels. Positive moves it away from the plot.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, scatter, streamgraph
axes.y.crosses
Data value where this axis crosses the other. 0 draws the axis through zero.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, density, errorbar, histogram, scatter +4
axes.y.minorTicks
Minor tick marks between major ticks. 0 hides them.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on density, streamgraph
axes.y.breaks
Ranges collapsed to a short gap. The break mark is drawn on the axis. When the segment below crosses zero, share is the fraction of the axis from zero to the break (default 0.4); otherwise share is the fraction for that whole segment.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y.bands
Shaded y ranges, such as a target zone.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2
Second (right) y axis, used by y series with axis 'y2'.boolean · default false · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.title
Axis title. Defaults to the channel title (none for time axes).text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format
Tick label format. Defaults to the channel format. On a strip this formats the ticks only. The row end label uses mark.labelFormat.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.decimals
Fixed number of fraction digits.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.currency
ISO 4217 code when style is 'currency'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.prefix
Text placed before the value.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.suffix
Text placed after the value, e.g. ' req/s'.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.signed
Always show + for positive numbers (useful for deltas).boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.format.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.ticks
Approximate tick count, the exact tick values, or "ends" for the first and last label only.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.grid
Grid lines from this axis.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on combo
axes.y2.position
Axis side. Defaults: x bottom, y left, y2 right. A side perpendicular to the axis maps onto the nearer end.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.titlePosition
Where the title sits along the axis. start is the minimum end (left or bottom). end is the maximum end. Default center.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.titleRotate
Axis title rotation in degrees. Default 0 on x, -90 on a left y axis, and 90 on a right y or y2 axis.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.autoSkip
Skip tick labels that would overlap. false draws every label. When omitted, crowded category labels still tilt about -40 degrees if that fits, and numeric ticks skip only when they collide.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on combo
axes.y2.labelWidth
Maximum tick-label width in pixels. Longer labels wrap, then ellipsize.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.labelLines
Maximum lines for a wrapped tick label. Enables wrapping at 72 pixels when labelWidth is omitted.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.line
Axis baseline. Off unless set. Color defaults to the axis token.boolean · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.line.color
Stroke color. Defaults to the axis token.color · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.line.width
Stroke width in pixels.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.line.dash
Stroke pattern.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.tickMarks
Tick marks at labeled ticks. none is the default. inside points into the plot.enum · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.tickLength
Tick mark length in pixels. Setting it draws outside marks unless tickMarks says otherwise.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.rotate
Tick label rotation in degrees. When omitted, crowded category labels rotate about -40 degrees unless autoSkip is true.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.offset
Shift the baseline outward in pixels. Positive moves it away from the plot.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.crosses
Data value where this axis crosses the other. 0 draws the axis through zero.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.minorTicks
Minor tick marks between major ticks. 0 hides them.number · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.breaks
Ranges collapsed to a short gap. The break mark is drawn on the axis. When the segment below crosses zero, share is the fraction of the axis from zero to the break (default 0.4); otherwise share is the fraction for that whole segment.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8
axes.y2.bands
Shaded ranges on the second y axis.json · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8

Labels

mark.labels
Draw value labels on the marks. Applies to: bar, donut, pie, line, stacked-area, scatter, radial-bar, rose, streamgraph. A streamgraph label is the series name at the thickest part of the layer.boolean · default false · bar, donut, pie, line, stacked-area, scatter, radial-bar, rose +3
mark.labelPosition
Where the value label sits. top, bottom, left, right, and center suit line, area, and scatter. inside and outside suit bar, donut, and pie. Outside pie and donut labels draw leader lines. Setting it turns labels on.enum · bar, donut, pie, line, stacked-area, scatter, combo
mark.labelFormat
Format preset for data labels. Falls back to the series format, then a plain number. Setting it turns labels on. On a strip it formats the end label, the note range, and the tooltip, and the axis ticks keep axes format.enum · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.decimals
Fixed number of fraction digits.number · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.currency
ISO 4217 code when style is 'currency'.text · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.prefix
Text placed before the value.text · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.suffix
Text placed after the value, e.g. ' req/s'.text · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.signed
Always show + for positive numbers (useful for deltas).boolean · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelFormat.specifier
d3-style format: .2f, ,.0f, $,.0f, .1%, .2e, +.1f, or s. A string format such as ".2f" is repaired to this.text · bar, donut, pie, line, stacked-area, scatter, combo, funnel +2
mark.labelEnds
Which line points are labelled. all, ends (first and last), or last. Setting it turns labels on. Applies to: line, stacked-area, combo.enum · line, stacked-area, combo
mark.stackTotal
Label the total of a stacked bar or stacked area. On a bar this also stacks the series. Applies to: bar, stacked-area.boolean · default false · bar, stacked-area
mark.baseLabel
Legend name for values that match no colour rule, such as Normal. The series entry is renamed to the series name plus this label, for example Reading: Normal, and it is a square when those values are bars. Omit it to keep the series name.text · line, bar, comboNot yet on line
mark.binLabel
Draw the bin count at the top right of the plot, clear of the y ticks. Omit it and that corner stays empty. Applies to: histogram.boolean · default false · histogram
axes.x.labels
Show tick labels.boolean · default true · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, errorbar, histogram, spike, strip +1
axes.y.labels
Show tick labels.boolean · default true · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8Not yet on area-range, bar-range, boxplot, candlestick, errorbar, histogram, spike, strip +1
axes.y2.labels
Show tick labels.boolean · default true · line, bar, stacked-area, combo, scatter, spike, candlestick, histogram +8

Legend

legend
Legend. true/false or settings. Default: shown when there is more than one series (or for donut).boolean · default true · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.position
Placement. inside draws over the plot; pair it with anchor.enum · default top · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.anchor
Anchor for an inside legend. Setting anchor without position uses inside.enum · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.align
Alignment of items within the legend block.enum · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.orient
Item flow. Default horizontal on the top and bottom, vertical on the sides.enum · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.maxRows
Maximum visible rows. Further rows page behind the first, with previous and next controls.number · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.title
Legend title.text · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.hide
Series names omitted from the legend. The series still draws.json · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.symbol
Marker used for every series unless symbols overrides it.enum · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.symbols
Per-series legend markers.json · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.interactive
Click a legend item to hide/show its series. Off unless set; the SVG records it as data-ck-intent.boolean · default false · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
legend.values
Show each series' value (last, or slice value for donut) next to its name.boolean · default false · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28Not yet on density, streamgraph

Tooltip & interaction

tooltip
Hover tooltip. true/false or settings. Default on for interactive charts.boolean · default true · All charts
tooltip.mode
'index' shows all series at the hovered x; 'nearest' shows the closest point only.enum · default index · All charts
tooltip.crosshair
Draw a vertical guide line at the hovered x.boolean · default true · All charts
tooltip.crosshairLabel
Print the hovered x value on the guide.boolean · default false · All charts
tooltip.position
Where the card sits. auto tries above, then below, then beside the point.enum · default auto · All charts
tooltip.background
Tooltip card fill. A CSS colour. The page reads it from the chart.text · All charts
tooltip.radius
Tooltip corner radius in px.number · All charts
tooltip.shadow
Tooltip box-shadow. A CSS shadow value.text · All charts
tooltip.crosshairColor
Crosshair stroke. A CSS colour.text · All charts
tooltip.fields
Fields to show, in this order. Omit to keep the encoded series. Strings are field names.json · All charts
tooltip.template
Row template. Tokens: {x}, {name}, {value}, {unit}, and data field names. One row per series.text · All charts
tooltip.pin
Tap to pin the tooltip. A second tap or Escape clears it. Pointer leave does not.boolean · default false · All charts
tooltip.hit
Hit radius in pixels. Larger targets help a finger. Pinning uses 18 when hit is omitted.number · All charts
interaction.hover
Highlight hovered marks and drive the tooltip.boolean · default true · All charts
interaction.select
Click selection. 'point' or 'series'. Shift, Ctrl, or Meta adds another. Escape or a background click clears. Selected marks use --ck-selected; others use --ck-dim. Emits pointclick or seriesclick, and selectionchange.enum · default none · All charts
interaction.zoom
Wheel/pinch zoom. Default 'x' for candlestick, otherwise 'none'.enum · All charts
interaction.pan
Drag to pan when zoomed.boolean · All charts
interaction.brush
Drag to select a range, emitted as 'rangechange'.enum · default none · All charts
interaction.initialRange
Initially visible x range [from, to] in data units (zoomable charts).json · All charts
interaction.export
Formats offered by the export menu. The SVG records them as data-ck-export. The menu loads only when this list is set. toPNG, toSVG, and toCSV are @chartkitdev/core/export.json · All charts
interaction.navigator
Overview sparkline and range slider under the chart. true, or an object with height. The slider loads with the interaction extras. The server SVG records data-ck-nav and does not include the control.boolean · line, bar, stacked-area, scatter, combo, candlestick, area-range, sparkline +2
interaction.navigator.height
Overview height in px. 28 to 96. A value outside that range warns CK3035 and the patch clamps it.number · line, bar, stacked-area, scatter, combo, candlestick, area-range, sparkline +2
interaction.sync
Group id. Charts with the same id share the crosshair, tooltip, and x window, matched on the x value. An empty string warns CK3036.text · All chartsNot yet on bar-list
interaction.drilldown.key
Data field that names the child. Default: encoding.x. A name that is not a field warns CK3039.text · All charts
interaction.drilldown.children
Child specs keyed by category. Each child needs a type. An empty map warns CK3037. A child with no type warns CK3038.text · All charts
animation
Entry/update animation. Always disabled when the user prefers reduced motion.boolean · default false · All charts
animation.duration
Milliseconds.number · default 400 · All charts
animation.easing
Easing curve.enum · default ease-out · All charts
motion
BETA. The API may change. How an update moves marks from the previous spec. Omitted and "none" are off, including every existing spec. "auto" is 320ms ease-out (cubic-bezier(0, 0, 0.58, 1)).enum · All charts
motion.duration
Milliseconds. Clamped to 0–800. 0 is off. Omitted means 320.number · All charts

Colors & theme

mark.palette
Series colours for this chart, in order. Overrides the theme palette. Omit it to keep the theme tokens. Applies to: line, bar, scatter, combo, stacked-area, donut, pie.json · line, bar, scatter, combo, stacked-area, donut, pie
mark.colorRules
Conditional colours. First match wins and overrides the series or category colour. A bar rule's legend swatch is the bar fill. A rule colour within CIE76 delta-E 25 of a series colour in the same theme shifts to a distinct shade.json · line, bar, scatter, combo, donut, pie
theme
Look and feel. A preset name, or an object combining a preset, a light/dark mode and token overrides. Every token is also read from CSS variables --ck-<token> (and --ck-series-N) on the container, so host design systems (e.g.enum · All charts
theme.mode
Force light or dark, or follow prefers-color-scheme.enum · default auto · All charts
theme.brand
Hex colour, or a list of up to eight. Shorthand #rgb and a missing hash are repaired to #rrggbb. render() derives light and dark tokens when @chartkitdev/core/themes/brand is imported. Until then the named preset is used.color · All charts
theme.tokens.background
Chart background. CSS value or var(--x).color · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +29
theme.tokens.surface
Card/tooltip background. CSS value or var(--x).color · gauge, kpi, quadrant, sankey, timeline, venn, tree
theme.tokens.text
Primary text. CSS value or var(--x).color · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +31
theme.tokens.muted
Secondary text, tick labels. CSS value or var(--x).color · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +31
theme.tokens.grid
Grid lines. CSS value or var(--x).color · line, bar, stacked-area, combo, scatter, boxplot, histogram, area-range +11
theme.tokens.axis
Axis lines. CSS value or var(--x).color · line, bar, stacked-area, combo, scatter, boxplot, histogram, strip +13
theme.tokens.accent
Highlight color (single-series default). CSS value or var(--x).color · gantt, quadrant, strip, density, timeline, waterfall, gauge, choropleth +1
theme.tokens.positive
Good/up color (deltas, up candles). CSS value or var(--x).color · candlestick, gantt, journey, quadrant, waterfall, kpi, line, bar +4
theme.tokens.negative
Bad/down color. CSS value or var(--x).color · candlestick, gantt, journey, quadrant, waterfall, kpi, line, bar +4
theme.tokens.fontFamily
CSS font-family. Omitted, or inherit, uses the page font. A list such as Georgia, serif sets --ck-font-family. At most 80 characters. No double quotes, <, >, ;, {, }, or backslash. Invalid values are CK3086.text · All charts
theme.tokens.fontSize
Base font size in px.number · All chartsNot yet on bar-list
theme.tokens.series
Categorical series palette in order. CSS colors or var(--x). Default: var(--ck-series-1..12) falling back to the preset.json · line, bar, donut, pie, stacked-area, scatter, combo, heatmap +28
theme.tokens.lines
Darker series ink, one per series colour, for thin strokes and strip labels. Omitted, labels use the series colour.color · All charts

Layout & size

size.width
Width in px, or 'auto' to fill the container and follow resizes.text · default auto · All charts
size.height
Height in px, or 'auto' to derive from width × aspectRatio or the container height.text · All charts
size.aspectRatio
width / height, used when height is 'auto' (e.g. 1.777 for 16:9).number · All charts
size.minHeight
Minimum height in px when responsive.number · All charts
size.padding
Inner padding in px around the plot, a number or per-side object. Default: automatic from axis label sizes.number · All charts
size.padding.top
Top padding in px.number · All charts
size.padding.right
Right padding in px.number · All charts
size.padding.bottom
Bottom padding in px.number · All charts
size.padding.left
Left padding in px.number · All charts
layout.direction
rtl mirrors a categorical x axis, moves the y axis to the right, and right-aligns the title. The SVG sets dir=rtl. Default ltr.enum · All chartsNot yet on bar-list
layout.coordinate
Coordinate system. polar is angle and radius, and it is how radial-bar and rose draw. Setting polar on bar repairs the type to radial-bar. On pie or donut it repairs to rose. On any other type the patch removes it (CK3077).enum · bar, pie, donut, radial-bar, roseNot yet on bar, donut, radial-bar, rose
layout.facet.field
Column that splits the data. A name that is not a field warns CK3041. Omitting it warns CK3040.text · All charts
layout.facet.columns
Panels across. 1 to 12. Outside that range warns CK3042 and the patch clamps it. Omit to choose from the category count.number · All charts
layout.facet.rows
Panels down. 1 to 12. Outside that range warns CK3043 and the patch clamps it.number · All charts
layout.facet.wrap
Flow extra categories onto new rows. false keeps the grid and warns CK3049 when categories do not fit.boolean · All charts
layout.facet.scales
shared (default) locks every panel to one nice y domain that includes the data max. Y labels and the y title sit on the outer column only, and x labels and the x title sit on the bottom row.enum · All charts
layout.facet.legend
shared (default) draws one legend under the grid. each repeats the legend in every panel.enum · All charts
layout.concat.columns
Wrap views into this many columns, 2 to 4. A view may set span to the number of columns it covers, so one wide chart can sit above two narrower ones. Omit to use direction.number · All charts
layout.concat.direction
vertical stacks the views. horizontal places them in a row. Ignored when columns is set.enum · All charts
layout.concat.gap
Space between views, in px. Default 16.number · All charts
layout.concat.views
Chart specs. A view with no type warns CK3045. An empty list warns CK3044.json · All charts
layout.breakpoints
The first rule whose width matches size.width, or the container width when width is auto, overrides the layout. A non-positive maxWidth warns CK3046. columns or rows without a facet field warns CK3047.json · All charts

Annotations

annotations
Reference rules, bands, text, trendlines, regression fits, and point callouts.json · All charts

Accessibility

a11y.alt
Short text alternative with the key insight, e.g. 'Revenue rose 18% from Jan to Jun 2026, peaking in May.'text · All charts
a11y.description
Longer description (methodology, caveats). Exposed via aria-describedby.text · All charts
a11y.keyboard
Arrow-key navigation between points and series with announcements. On by default when an adapter mounts the chart on the client; set false to turn the keys off and keep the chart SVG out of the tab order.boolean · default true · All charts
a11y.dataTable
A data table for screen readers, visually hidden, capped at 1000 evenly spaced rows. On by default when an adapter mounts the chart on the client; set false to leave it out. true also adds a visible 'Show data table' button.boolean · default true · All charts

Advanced

type
Chart type. Put it in type, never in mark (mark is an options object). 'line': Lines over a continuous x (usually time). One or more y fields. Replaces LineChart. 'bar': Bars per category (x). Grouped or stacked; vertical or horizontal.enum · All charts
id
Optional stable id (used for keys, events, test hooks).text · All charts
title
Visible chart title; also the accessible name.text · All charts
subtitle
Visible secondary line under the title.text · All charts
headline.label
Small label above the value.text · All charts
headline.value
Primary figure, drawn in the chart.text · All charts
headline.compare
Secondary comparison figure, in the muted colour.text · All charts
headline.delta
Change badge, drawn as a pill.text · All charts
headline.tone
Pill colour. positive uses the positive token, negative the negative token.enum · All charts
render
How the marks are drawn. svg is the default and what render() always returns, including on the server, with the marks included.enum · default svg · line, stacked-area, scatter, bar, heatmap, candlestick
locale
BCP 47 locale for number/date formatting. Default: the host's locale.text · All chartsNot yet on quadrant, radar, stacked-area
timezone
IANA time zone for temporal axes, ticks, and tooltips. Omitted means UTC, so a server render and the client label the same instant the same way.text · line, bar, stacked-area, scatter, combo, sparkline, mini-area, spike +2
sort.field
Field to sort by.text · All chartsNot yet on boxplot, heatmap, histogram, tree, venn
sort.by
Sort by the first y value. Used for bars.enum · All chartsNot yet on boxplot, heatmap, histogram, tree, venn
sort.order
Sort direction. Default ascending.enum · All chartsNot yet on boxplot, heatmap, histogram, tree, venn
transform
Row steps applied before sort: filter, a rolling window, or an aggregate.json · All charts