mochart

Appearance

Series Config ​

Configure the chart series.

series is a list section: it takes an array of config objects (a single object is also accepted and treated as a one-entry array). Values shared by every entry can be set once in seriesDefaults; a value set on an individual entry wins over the shared one.

Every property is optional and falls back to its default, except property, which must be given. Property anchors are stable: link to any entry as #series.propertyName, and to a member of a nested property as #series.propertyName.memberName.

allowAbsentDataProperties ​

Whether a series data property absent from the data provider is read as all-missing values instead of a data error.

Covers every data property the series names — property, rangeProperty, errorLowProperty, errorHighProperty, markerProperty, labelProperty, tooltipProperty and colorProperty. Kept false by default so a misspelled property name is still reported by getDataErrors; enable it for a series that may genuinely have no data behind it, which then draws nothing but keeps its legend and tooltip entries. A property that is present but has the wrong number of values is still an error.

animateBaseFromAdjacent ​

Whether a value that enters or leaves animates from or to its adjacent values (true) or the base value (false): a leading or trailing value takes the neighbour it joins, an interior value the point between its neighbours at its category position.

  • Default:
    • false — when renderer is bar
    • true — when renderer is line
    • true — when renderer is area
    • false — when renderer is none
  • Validation: should be a boolean

axis ​

The unique identifier of the value axis that the series belongs to.

Assigns the series to the value axis in valueAxes whose id matches. With a single configured axis this can be omitted — it defaults to that axis id.

bar ​

The bars drawn by a bar renderer series: their width and placement within the layout slot, and their minimum extent.

bar.alignFraction ​

The fraction (0 - 1) of the slot width freed by widthFraction placed before each bar in the series (0 aligns with the slot start, 0.5 centers, 1 aligns with the slot end).

Only affects the bar renderer, and only when widthFraction is less than 1. Lets narrowed bars from different series share one slot side by side — e.g. the left open tick and right close tick of an OHLC bar.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
  • Used in: OHLC bars · OHLC Bars

bar.minExtent ​

The minimum extent (in pixels) of each bar in the series along the value direction.

Only affects the bar renderer. A bar whose two ends resolve to (nearly) the same position — e.g. a ranged bar whose property and rangeProperty values are equal — is expanded to this extent, centered on its position, so it stays visible as a tick mark: e.g. the open/close ticks of an OHLC bar, or a candlestick doji body. At the default 0 such a bar — including a plain bar whose value equals the axis base — draws nothing and has no hit area.

bar.widthFraction ​

The fraction (0 - 1) of the bar layout slot width to use when drawing bars in the series.

Only affects the bar renderer. Narrows each bar within its layout slot (the full category slot, or the series’ sub-slot when grouped), so a narrow bar can overlay a full-width one from another series — e.g. a candlestick wick behind its body, or a bullet-chart measure over its backing range. The narrowed bar is centered by default; alignFraction moves it within the slot.

cap ​

The decorative cap drawn on the value end of each bar in a bar series.

cap.expand ​

Whether to expand the base of caps on a bar series when the size of the cap is greater than the extent of the bar.

cap.onlyStackOuter ​

Whether to only show the cap on bars in the series when they are an outer series of a stack.

cap.size ​

The size of the cap (in pixels) to use when drawing caps on a bar series.

cap.type ​

The type (point, curve, round, use null for none) of cap to use when drawing caps on a bar series.

Draws a decorative cap on the value end of each bar in the series; size controls its extent. To cap only the outside of a stacked bar, see onlyStackOuter and seriesStacks[].outerCap.type.

colorProperty ​

The property to retrieve from the data provider for the series color values (use null for none, to color by style instead).

The values retrieved for this property must be numbers, like property, mapped through colorScale; a missing value takes colorScale.missing.

  • Default: null
  • Validation: should be a string naming a data property or be equal to null when chart type is xy and renderer is bar, and colorScale is not null; should be equal to null when chart type is not xy or renderer is not bar, or colorScale is null
  • Used in: Heatmap · Color by value · Color and Base Property · Color Property

colorScale ​

The color ramp the series color values are mapped through.

colorScale.base ​

The data threshold that splits the color ramp in two, and the two ramps either side of it.

colorScale.base.aboveMax ​

The maximum color to use when interpolating the series shape color with a color property value that is above the base value (use null for none).

  • Default:
    • null — when colorProperty is null
    • null — when colorProperty is not null and colorScale.base.value is null
    • #0000ff — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is null; should be a valid color when colorProperty is not null and colorScale.base.value is not null
  • Used in: Diverging around a base · Color and Base Property

colorScale.base.aboveMin ​

The minimum color to use when interpolating the series shape color with a color property value that is above the base value (use null for none).

  • Default:
    • null — when colorProperty is null
    • null — when colorProperty is not null and colorScale.base.value is null
    • #8f8fff — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is null; should be a valid color when colorProperty is not null and colorScale.base.value is not null
  • Used in: Diverging around a base · Color and Base Property

colorScale.base.belowMax ​

The maximum color to use when interpolating the series shape color with a color property value that is below the base value (use null for none).

  • Default:
    • null — when colorProperty is null
    • null — when colorProperty is not null and colorScale.base.value is null
    • #ff8f8f — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is null; should be a valid color when colorProperty is not null and colorScale.base.value is not null
  • Used in: Diverging around a base · Color and Base Property

colorScale.base.belowMin ​

The minimum color to use when interpolating the series shape color with a color property value that is below the base value (use null for none).

  • Default:
    • null — when colorProperty is null
    • null — when colorProperty is not null and colorScale.base.value is null
    • #ff0000 — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is null; should be a valid color when colorProperty is not null and colorScale.base.value is not null
  • Used in: Diverging around a base · Color and Base Property

colorScale.base.value ​

The base value to use for color interpolation, allowing 2 distinct sets of min & max colors for interpolation (use null for none).

colorScale.interpolation ​

The type of d3 color interpolation to apply when using a color property (rgb, hsl, lab, hcl) (use null for none).

  • Default:
    • null — when colorProperty is null
    • "hcl" — when colorProperty is not null
  • Validation: should be one of [ "rgb", "hsl", "lab", "hcl" ] when colorProperty is not null; should be equal to null when colorProperty is null
  • Used in: Heatmap · Color by value · Color and Base Property · Color Property

colorScale.max ​

The maximum color to use when interpolating the series shape color with a color property (use null for none).

  • Default:
    • null — when colorProperty is null
    • #0000ff — when colorProperty is not null and colorScale.base.value is null
    • null — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is not null; should be a valid color when colorProperty is not null and colorScale.base.value is null
  • Used in: Heatmap · Color by value · Color Property

colorScale.min ​

The minimum color to use when interpolating the series shape color with a color property (use null for none).

  • Default:
    • null — when colorProperty is null
    • #8f8fff — when colorProperty is not null and colorScale.base.value is null
    • null — when colorProperty is not null and colorScale.base.value is not null
  • Validation: should be equal to null when colorProperty is null; should be equal to null when colorProperty is not null and colorScale.base.value is not null; should be a valid color when colorProperty is not null and colorScale.base.value is null
  • Used in: Heatmap · Color by value · Color Property

colorScale.missing ​

The color drawn for a value whose color property value is missing (use null to fall back to the series style colors).

  • Default:
    • null — when colorProperty is null
    • #cccccc — when colorProperty is not null
  • Validation: should be equal to null when colorProperty is null; should be a valid color or be equal to null when colorProperty is not null

curve ​

The d3 curve type and param to use when drawing the series shape.

Only affects the line and area renderers. type selects the d3-shape curve (linear, monotoneX, natural, step, cardinal, catmullRom, …) and param sets the tension of a cardinal curve or the alpha of a catmullRom one — the only two types with a configurator, so the others reject it.

curve.param ​

The tension value (0 - 1) for the cardinal curve type or the alpha value for catmullRom, or undefined to use the curve's own default (the other curve types take no param).

  • Default: none
  • Validation: should be a number >= to 0 and <= 1 when curve.type is cardinal or catmullRom; should be equal to undefined for the other curve types

curve.type ​

The d3-shape curve to interpolate the series shape with.

  • Default: "linear"
  • Validation: should be one of [ "linear", "monotoneX", "monotoneY", "basis", "cardinal", "catmullRom", "natural", "step", "stepBefore", "stepAfter" ]
  • Used in: Curves · Curved Lines

errorBar ​

The error bars drawn from the series errorLowProperty and errorHighProperty bounds.

  • Default: { capSize: 6, style: { … } }
  • Validation: should be an object with any of the properties { capSize, style }

errorBar.capSize ​

The full width (in pixels) of the horizontal caps drawn at the ends of the series error bars (use 0 to hide the caps).

The caps are the horizontal ticks at the whisker ends. On a bar renderer series the cap width is clamped to the bar layout slot so caps never overlap a neighbouring bar; use 0 to draw plain whiskers without caps.

  • Default: 6
  • Validation: should be a number >= to 0

errorBar.style ​

The style of the series error bars.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { defocused, focused, normal }

errorBar.style.defocused ​

The style of the series error bars, while the series is defocused.

errorBar.style.defocused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette errorBar color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
errorBar.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
errorBar.style.defocused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
errorBar.style.defocused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1.5
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

errorBar.style.focused ​

The style of the series error bars, while the series is focused.

errorBar.style.focused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette errorBar color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
errorBar.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
errorBar.style.focused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
errorBar.style.focused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1.5
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

errorBar.style.normal ​

The style of the series error bars, while the series is neither focused nor defocused.

errorBar.style.normal.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "seriesIndex" / "categoryIndex" to take the matching colorPalette errorBar color by series or category index.

  • Default: "series"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "seriesIndex", "categoryIndex" ]
errorBar.style.normal.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: null
  • Validation: should be a valid dash array or be equal to null
errorBar.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.9
  • Validation: should be a number >= to 0 and <= 1
errorBar.style.normal.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1.5
  • Validation: should be a number >= to 0 or be equal to null

errorHighProperty ​

The property to retrieve from the data provider for the absolute upper error bound values used to draw error bars (use null for none).

See errorLowProperty — the same rules apply to the upper bound.

  • Default: null
  • Validation: should be equal to null when stack is not null; should be a string naming a data property or be equal to null when stack is null
  • Used in: Error bars · Error Bars

errorLowProperty ​

The property to retrieve from the data provider for the absolute lower error bound values used to draw error bars (use null for none).

The values retrieved for this property must be numbers, like property. The bounds are absolute values in value axis units, not deltas from the series value, and they join the value axis domain so the whiskers never clip. Either bound can be used alone for a one-sided error bar; a category whose bound is undefined just omits that side of the whisker. Error bars draw on bar, line, area and none renderer series (centered on each bar — including grouped sub-slot bars — or on each point), but not on stacked series, where absolute bounds have no meaning against the cumulative stack position.

  • Default: null
  • Validation: should be equal to null when stack is not null; should be a string naming a data property or be equal to null when stack is null
  • Used in: Error bars · Error Bars

filterable ​

Whether or not the series can be filtered out of the chart via the legend or tooltip (no effect when followSeries is set: the followed series’ filterable decides).

  • Default: true
  • Validation: should be a boolean

focusCategoryOnClick ​

Whether the category should be focused whenever the user clicks/taps a category of the series in the chart.

  • Default: false
  • Validation: should be a boolean

focusCategoryOnHover ​

Whether the category should be focused whenever the user hovers the pointer over a category of the series in the chart.

  • Default: false
  • Validation: should be a boolean

focusOnClick ​

Whether the series should be focused whenever the user clicks/taps a part of it in the chart.

  • Default: false
  • Validation: should be a boolean

focusOnHover ​

Whether the series should be focused whenever the user hovers the pointer over a part of it in the chart.

  • Default: false
  • Validation: should be a boolean

followSeries ​

The unique identifier of another series whose legend filtering and focus this series follows (use null for none).

When the referenced series is toggled out of (or back into) the chart via the legend, this series follows it, and it shares the referenced series’ focus state both ways: focusing the leader highlights this series too, and focus interactions on this series target the leader. For companion series that visually belong to a legend series — e.g. a candlestick wick following its body — so filtering or focusing treats the whole mark as one. It has no focus or filter state of its own for either: focusedSeriesId and the filteredSeriesIds keys should be ids of series that do not set followSeries, and this series’ own id has no effect there. It is kept out of the legend by default (showInLegend), since its item could only repeat the followed series’ own.

  • Default: null
  • Validation: should be a string or be equal to null; should equal the id property of one of the series; should equal the id property of a series that does not itself set followSeries
  • Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars

gradient ​

The unique id of the gradient config used to fill an area or bar series, or a pie slice (use null for none; cannot be combined with pattern or colorProperty).

  • Default: sole gradient id — when chart type is pie or renderer is area or bar, colorProperty is null, and no shapeStyle fillColor is categoryIndex
  • Validation: should be equal to null when chart type is not pie and renderer is not area or bar; should be equal to null when colorProperty is not null; should be equal to null when a shapeStyle fillColor is categoryIndex; should be a string or be equal to null when chart type is pie or renderer is area or bar; should equal the id property of one of the linearGradients or radialGradients
  • Used in: Gradients

group ​

The unique identifier of the series group that the series belongs to (use null for none).

Series sharing the same group id (an id from seriesGroups) are laid out side by side within each category slot — grouped/clustered bars. Series in the group that also share a stack share one sub-slot, so stacks placed in the same group become side-by-side stacked columns. Defaults to the sole group id when exactly one series group is configured; use null to opt a series out.

id ​

The unique identifier for the series.

ignore ​

Whether to ignore this series and treat it as though it were not specified.

  • Default: false
  • Validation: should be a boolean

label ​

The labels drawn next to the series shapes from the labelProperty values.

label.aboveBase ​

The label placement applied only to series values above the base value ("auto" falls back to the plain label setting).

label.aboveBase.maxPositionFraction ​

The maxPositionFraction bound applied only to series values on this side of the base value (use "auto" to inherit maxPositionFraction, null for none).

  • Default: "auto"
  • Validation: should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]

label.aboveBase.minPositionFraction ​

The minPositionFraction bound applied only to series values on this side of the base value (use "auto" to inherit minPositionFraction, null for none).

  • Default: "auto"
  • Validation: should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]

label.aboveBase.offset ​

The series position offset (in pixels) to apply to all series label positions on this side of the base value (use "auto" to derive from the label offset: as it is above the base, negated below it).

  • Default: "auto"
  • Validation: should be a number or be equal to "auto"

label.aboveBase.position ​

The position (inside, center, outside) applied only to series values on this side of the base value (use "auto" to inherit position).

  • Default: "auto"
  • Validation: should be one of [ "auto", "inside", "center", "outside" ]

label.belowBase ​

The label placement applied only to series values below the base value ("auto" falls back to the plain label setting).

label.belowBase.maxPositionFraction ​

The maxPositionFraction bound applied only to series values on this side of the base value (use "auto" to inherit maxPositionFraction, null for none).

  • Default: "auto"
  • Validation: should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]

label.belowBase.minPositionFraction ​

The minPositionFraction bound applied only to series values on this side of the base value (use "auto" to inherit minPositionFraction, null for none).

  • Default: "auto"
  • Validation: should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]

label.belowBase.offset ​

The series position offset (in pixels) to apply to all series label positions on this side of the base value (use "auto" to derive from the label offset: as it is above the base, negated below it).

  • Default: "auto"
  • Validation: should be a number or be equal to "auto"

label.belowBase.position ​

The position (inside, center, outside) applied only to series values on this side of the base value (use "auto" to inherit position).

  • Default: "auto"
  • Validation: should be one of [ "auto", "inside", "center", "outside" ]

label.format ​

The d3 format string to be applied to the series label values (use null for none, use "auto" to derive from data).

label.maxPositionFraction ​

The maximum position fraction (0 - 1) from the domain maximum for which series labels should be shown (use null for none).

  • Default: null
  • Validation: should be a number >= to 0 and <= 1 or be equal to null

label.minPositionFraction ​

The minimum position fraction (0 - 1) from the domain minimum for which series labels should be shown, measured outward from the base instead when the value axis has one (use null for none).

label.minRangeFraction ​

Hide the label of any value whose shape spans less than this fraction (0 - 1) of the axis domain (use null for none).

label.offset ​

The series position offset (in pixels) to apply to all series label positions.

label.position ​

Where to place the series labels relative to the value end of the series shape (inside, center, outside).

label.prefix ​

The text to prefix series label values with when drawing them on the plot (use null for none).

  • Default: null
  • Validation: should be a string or be equal to null

label.suffix ​

The text to append series label values with when drawing them on the plot (use null for none).

  • Default: null
  • Validation: should be a string or be equal to null

label.textStyle ​

The style of the series label values.

label.textStyle.defocused ​

The style of the series label values, while the series is defocused.

label.textStyle.defocused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
label.textStyle.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
label.textStyle.defocused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
label.textStyle.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
label.textStyle.defocused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
label.textStyle.defocused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

label.textStyle.focused ​

The style of the series label values, while the series is focused.

label.textStyle.focused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
label.textStyle.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
label.textStyle.focused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
label.textStyle.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
label.textStyle.focused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
label.textStyle.focused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

label.textStyle.normal ​

The style of the series label values, while the series is neither focused nor defocused.

label.textStyle.normal.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

label.textStyle.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

label.textStyle.normal.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "seriesIndex" / "categoryIndex" to take the matching colorPalette label color by series or category index.

label.textStyle.normal.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: null
  • Validation: should be a valid dash array or be equal to null
label.textStyle.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.8
  • Validation: should be a number >= to 0 and <= 1
label.textStyle.normal.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1
  • Validation: should be a number >= to 0 or be equal to null

labelProperty ​

The property to retrieve from the data provider for the series label values (use null for none).

The values retrieved for this property must be numbers, like property — formatted by label.format, not label text; a missing value draws no label for that category.

marker ​

The markers drawn at each series value.

marker.minSize ​

The minimum marker size (in pixels) that a marker scaled by a marker property value shrinks to (ignored without a markerProperty).

Only used with a markerProperty: the size the smallest marker property value scales down to; the largest takes size.

marker.shape ​

The shape to use when drawing the series marker (circle, cross, diamond, square, star, triangle, wye) (use null for none).

marker.showForMissingValues ​

Whether to still show a marker at missing values (most useful with missingValueMode "base", which gives the marker a position).

  • Default: false
  • Validation: should be a boolean

marker.size ​

The marker size (in pixels); with a markerProperty it is the size of the largest value, and the markers scale down from it toward minSize.

Without a markerProperty every marker is drawn at exactly this size, and minSize is not used. With one, the series value with the largest marker property value gets this size and the others scale down toward minSize by sizeScale, so size is the top of the range and minSize the bottom — there is no separate maximum.

marker.sizeScale ​

The scale used to interpolate marker sizes from marker property values ("sqrt" scales the marker area with the value, "linear" scales its diameter).

  • Default: "sqrt"
  • Validation: should be one of [ "sqrt", "linear" ]

marker.style ​

The style of the series marker.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { defocused, focused, normal }

marker.style.defocused ​

The style of the series marker, while the series is defocused.

marker.style.defocused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
marker.style.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 0.8
  • Validation: should be a number >= to 0 and <= 1
marker.style.defocused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
marker.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
marker.style.defocused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.8
  • Validation: should be a number >= to 0 and <= 1
marker.style.defocused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

marker.style.focused ​

The style of the series marker, while the series is focused.

marker.style.focused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
marker.style.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
marker.style.focused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "same", "seriesIndex", "categoryIndex" ]
marker.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]
marker.style.focused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
marker.style.focused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 3
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]

marker.style.normal ​

The style of the series marker, while the series is neither focused nor defocused.

marker.style.normal.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "series"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "seriesIndex", "categoryIndex" ]
marker.style.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 0.9
  • Validation: should be a number >= to 0 and <= 1
marker.style.normal.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "series" to use the color of the series shape, or "seriesIndex" / "categoryIndex" to take the matching colorPalette marker color by series or category index.

  • Default: "series"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "series", "seriesIndex", "categoryIndex" ]
marker.style.normal.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: null
  • Validation: should be a valid dash array or be equal to null
marker.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.9
  • Validation: should be a number >= to 0 and <= 1
marker.style.normal.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: 1
  • Validation: should be a number >= to 0 or be equal to null

markerProperty ​

The property to retrieve from the data provider for the marker size values (use null for none).

The values retrieved for this property must be numbers, like property; a missing value draws no marker for that category.

missingValueMode ​

What to draw at a category whose value is missing: break the shape at the gap (break), connect the neighbouring defined values (connect), or draw the point at the value axis base value (base).

With "connect", lines and areas bridge missing categories directly between the neighbouring defined values; with "base" the point is drawn at the value axis base value; the default "break" leaves a gap in the shape. For a series with a rangeProperty, a category counts as missing only when both properties are undefined — see partialRangeIsMissing.

order ​

The unique integer order of the series controlling its order of appearance.

  • Default: ${index}
  • Validation: should be an integer; should be unique

partialRangeIsMissing ​

Whether to treat a value as missing when either of property or rangeProperty is undefined, instead of collapsing to the defined one.

Only affects series with a rangeProperty (stacked series are unaffected). By default a category with just one of property/rangeProperty undefined keeps a zero-extent span collapsed at the defined value, so ranged areas stay connected through it. When true such categories count as missing instead, following the configured missingValueMode treatment.

pattern ​

The unique id of the pattern config used to fill an area or bar series, or a pie slice (use null for none; cannot be combined with gradient).

  • Default: sole pattern id — when chart type is pie or renderer is area or bar
  • Validation: should be equal to null when chart type is not pie and renderer is not area or bar; should be equal to null when gradient is not null; should be a string or be equal to null when chart type is pie or renderer is area or bar, and gradient is null; should equal the id property of one of the patterns
  • Used in: Patterns

property ​

The property to retrieve from the data provider for the series values.

The chart reads this property from each category of the data provider to get the series value — it is the only series property without a default, so every series must set it. The values retrieved for this property must be numbers; null, undefined or NaN reads as a missing value. Use getDataErrors to check a dataset against the configured properties.

rangeProperty ​

The property to retrieve from the data provider for the secondary series values (use null for none).

The values retrieved for this property must be numbers, like property. When set, the series shape spans from the rangeProperty value to the property value instead of starting at the axis base — producing floating bars, a banded (low/high) area, or a pair of lines with the line renderer.

renderer ​

The shape renderer to use when drawing the series shape (line, area, bar, none).

bar draws a rectangle per category value, line connects the values with a path, area fills between the value line and the value axis base — or, when no base is set, the minimum end of the axis — and none draws no shape. Different series in the same chart can use different renderers, e.g. bars with a line overlay.

shapeStyle ​

The style of the series shape.

shapeStyle.defocused ​

The style of the series shape, while the series is defocused.

shapeStyle.defocused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "same", "seriesIndex", "categoryIndex" ]

shapeStyle.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default:
    • 0.5 — when renderer is bar
    • 0.8 — when renderer is line
    • 0.5 — when renderer is area
    • 0.8 — when renderer is none
  • Validation: should be a number >= to 0 and <= 1
  • Used in: Hollow candles · Hollow Candlestick

shapeStyle.defocused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "same", "seriesIndex", "categoryIndex" ]

shapeStyle.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]

shapeStyle.defocused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default:
    • 0.5 — when renderer is bar
    • 0.8 — when renderer is line
    • 0.5 — when renderer is area
    • 0.8 — when renderer is none
  • Validation: should be a number >= to 0 and <= 1

shapeStyle.defocused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default:
    • 0 — when renderer is bar
    • 2 — when renderer is line
    • 0 — when renderer is area
    • 0 — when renderer is none
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]
  • Used in: Hollow candles · Hollow Candlestick

shapeStyle.focused ​

The style of the series shape, while the series is focused.

shapeStyle.focused.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "same", "seriesIndex", "categoryIndex" ]

shapeStyle.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default:
    • 1 — when renderer is bar
    • 1 — when renderer is line
    • 1 — when renderer is area
    • 1 — when renderer is none
  • Validation: should be a number >= to 0 and <= 1
  • Used in: Hollow candles · Hollow Candlestick

shapeStyle.focused.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "same" to use the color of the normal state, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be one of [ "same", "seriesIndex", "categoryIndex" ]

shapeStyle.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: "same"
  • Validation: should be a valid dash array or be one of [ null, "same" ]

shapeStyle.focused.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default:
    • 1 — when renderer is bar
    • 1 — when renderer is line
    • 1 — when renderer is area
    • 1 — when renderer is none
  • Validation: should be a number >= to 0 and <= 1

shapeStyle.focused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default:
    • 1 — when renderer is bar
    • 4 — when renderer is line
    • 1 — when renderer is area
    • 0 — when renderer is none
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]
  • Used in: Hollow candles · Hollow Candlestick

shapeStyle.normal ​

The style of the series shape, while the series is neither focused nor defocused.

shapeStyle.normal.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

shapeStyle.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

shapeStyle.normal.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color, or "seriesIndex" / "categoryIndex" to take the matching colorPalette shape color by series or category index.

shapeStyle.normal.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: null
  • Validation: should be a valid dash array or be equal to null
  • Used in: Curves

shapeStyle.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

shapeStyle.normal.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default:
    • 0 — when renderer is bar
    • 3 — when renderer is line
    • 0 — when renderer is area
    • 0 — when renderer is none
  • Validation: should be a number >= to 0 or be equal to null
  • Used in: Hollow candles · Hollow Candlestick

showColorInLegend ​

Whether to show the series color as an icon next to the series title in the legend.

  • Default: true
  • Validation: should be a boolean

showColorInTooltip ​

Whether to show the series color as an icon next to the series title in the tooltip.

  • Default: true
  • Validation: should be a boolean

showInLegend ​

Whether to show the series in the legend.

showInTooltip ​

Whether to show the series in the tooltip.

showPointer ​

Whether to show the pointer cursor when the user mouses over the series shapes in the chart.

Sets cursor: pointer on the series’ shapes (bars, markers, labels and line/area paths — or its pie slices), advertising that clicking does something. Typically paired with the onSeriesClick/onSliceClick callbacks or focusOnClick, which make the shapes clickable but leave the cursor unchanged by default.

  • Default: false
  • Validation: should be a boolean

stack ​

The unique identifier of the series stack that the series belongs to (use null for none).

Series sharing the same stack id (an id from seriesStacks) are drawn stacked on one another and animate as a single unit, so the stack stays gapless mid-transition. All series of a stack must share the same axis and the same group (or all be ungrouped) — a stack cannot span groups, since each group lays its stacks out in its own sub-slots. Defaults to the sole stack id when exactly one stack is configured; use null to opt a series out.

  • Default: sole stack id
  • Validation: should be a string or be equal to null; should equal the id property of one of the seriesStacks; should equal the id property of one of the seriesStacks that has the same axis property; should equal the id property of a series stack whose series all share this series' group property
  • Used in: Waterfall · Heatmap · Candlestick · Stacked · Stacked & Grouped · Axis Filtering Adjustment · +5 more

title ​

The title to display for the series in the legend (use null for none).

tooltipProperty ​

The property to retrieve from the data provider for the values shown for the series in the tooltip in place of the series values (use null for none).

The values retrieved for this property must be numbers, like property, formatted by the series valueFormat; a missing value shows the tooltip's missing-value text for that category.

  • Default: null
  • Validation: should be a string naming a data property or be equal to null
  • Used in: Heatmap

useAxisFocus ​

Whether to show the series as focused when the value axis it belongs to is focused.

  • Default: true
  • Validation: should be a boolean

useTitleForValueLabel ​

Whether to use the title value for the valueLabel value when the valueLabel is not set.

  • Default: true
  • Validation: should be a boolean

valueFormat ​

The d3 format string to be applied to the series value when displayed in the tooltip (use null for none, use "auto" to derive from data ("auto" will use the value axis tick label format if it is set)).

A d3-format specifier applied to the value shown in the tooltip, e.g. ".1f" or ",.0f". "auto" derives a format from the data, preferring the value axis tickLabel.format when that is set.

valueLabel ​

The label to show before a series value in the tooltip (null falls back to useTitleForValueLabel, it does not mean no label).

valuePrefix ​

The text to prefix series values with when showing them in the tooltip (use null for none).

  • Default: null
  • Validation: should be a string or be equal to null
  • Used in: Tooltip formatting

valueSuffix ​

The text to append series values with when showing them in the tooltip (use null for none).

  • Default: null
  • Validation: should be a string or be equal to null
  • Used in: Tooltip formatting

Released under the MIT License.