mochart

Appearance

Value Axis Config ​

Configure the chart value axes content and styling.

valueAxes 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 valueAxisDefaults; a value set on an individual entry wins over the shared one.

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

A property holding a list of objects documents the members of one entry, headed thresholds[].front. Their anchors leave the brackets out: #valueAxes.thresholds.front.

adjustForFiltering ​

Whether to adjust the domain of the axis as series belonging to it are filtered.

axisLine ​

The line drawn along the length of the axis.

axisLine.front ​

Whether the axis line should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

axisLine.marginInner ​

The margin (in pixels) between the line shown along the axis and the inner boundary of the axis.

axisLine.style ​

The style of the line shown along the axis.

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

axisLine.style.defocused ​

The style of the line shown along the axis, while the axis is defocused.

axisLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
axisLine.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

axisLine.style.focused ​

The style of the line shown along the axis, while the axis is focused.

axisLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
axisLine.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

axisLine.style.normal ​

The style of the line shown along the axis, while the axis is neither focused nor defocused.

axisLine.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
axisLine.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
axisLine.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.65
  • Validation: should be a number >= to 0 and <= 1
axisLine.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

axisLine.visible ​

Whether to show a line along the length of the axis.

backgroundFront ​

Whether the axis background should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

backgroundStyle ​

The styles to apply to the axis background (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).

backgroundStyle.fillColor ​

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: null
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

backgroundStyle.fillOpacity ​

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

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

backgroundStyle.strokeColor ​

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

backgroundStyle.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

backgroundStyle.strokeOpacity ​

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

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

backgroundStyle.strokeWidth ​

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

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

base ​

The numeric base value of the axis, used for animation and relative positioning for shapes (use null for none).

The value shapes are measured from: bars and areas grow from it, missingValueMode: 'base' puts missing values on it, and shapes animate from it when series enter or leave. With mixed positive/negative data it separates the two directions. When left unspecified, un-ranged bar and area series use the minimum end of the axis, and other series use min when it is set, otherwise the smallest value in the data.

baseLine ​

The line drawn along the base value of the axis.

  • Default: { visible: true, front: false, style: { … } }
  • Validation: should be an object with any of the properties { front, style, visible }
  • Used in: Sparklines

baseLine.front ​

Whether the base line should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

baseLine.style ​

The style of the line shown along the base of the axis.

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

baseLine.style.defocused ​

The style of the line shown along the base of the axis, while the axis is defocused.

baseLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
baseLine.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

baseLine.style.focused ​

The style of the line shown along the base of the axis, while the axis is focused.

baseLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
baseLine.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

baseLine.style.normal ​

The style of the line shown along the base of the axis, while the axis is neither focused nor defocused.

baseLine.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
baseLine.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
baseLine.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.65
  • Validation: should be a number >= to 0 and <= 1
baseLine.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

baseLine.visible ​

Whether to show a line along the base of the axis.

  • Default: true
  • Validation: should be a boolean
  • Used in: Sparklines

collapsed ​

Whether the axis should consume space in the layout (false) or not (true).

  • Default: false
  • Validation: should be a boolean

focusOnClick ​

Whether the value axis 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 value axis should be focused whenever the user hovers the pointer over a part of it in the chart.

  • Default: true
  • Validation: should be a boolean

focusRange ​

The band drawn over the axis at its focused series domain or category value.

  • Default: { visible: true, front: false, applyToTitle: false, style: { … } }
  • Validation: should be an object with any of the properties { applyToTitle, front, style, visible }

focusRange.applyToTitle ​

Whether to show the focus range only over tick labels (false) or over both tick labels and title (true).

  • Default: false
  • Validation: should be a boolean

focusRange.front ​

Whether the focus range should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

focusRange.style ​

The style of the focus range.

focusRange.style.fillColor ​

The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")

focusRange.style.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 0.12
  • Validation: should be a number >= to 0 and <= 1

focusRange.style.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")

focusRange.style.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

focusRange.style.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.2
  • Validation: should be a number >= to 0 and <= 1

focusRange.style.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

focusRange.visible ​

Whether to show the focus range on the axis when it has a focused series domain or category value.

  • Default: true
  • Validation: should be a boolean

focusTickMark ​

The tick marks drawn perpendicular to the axis at its focused series domain or category value.

  • Default: { visible: false, front: false, size: 9, marginInner: 3, style: { … } }
  • Validation: should be an object with any of the properties { front, marginInner, size, style, visible }

focusTickMark.front ​

Whether the focus tick marks should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

focusTickMark.marginInner ​

The margin (in pixels) to show between the inside of the axis and the focus tick mark line(s).

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

focusTickMark.size ​

The length (in pixels) of the focus tick mark line(s).

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

focusTickMark.style ​

The style of the focus tick mark line(s).

focusTickMark.style.strokeColor ​

The color of the stroke (outline): use "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")

focusTickMark.style.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

focusTickMark.style.strokeOpacity ​

The opacity (0 - 1) of the stroke.

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

focusTickMark.style.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 equal to null

focusTickMark.visible ​

Whether to show lines perpendicular to the axis showing the focused series domain or category value.

  • Default: false
  • Validation: should be a boolean

gridLine ​

The grid lines drawn across the plot at each tick on the axis.

gridLine.front ​

Whether the axis grid lines should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

gridLine.style ​

The style of the axis grid lines.

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

gridLine.style.defocused ​

The style of the axis grid lines, while the axis is defocused.

gridLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
gridLine.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

gridLine.style.focused ​

The style of the axis grid lines, while the axis is focused.

gridLine.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
gridLine.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

gridLine.style.normal ​

The style of the axis grid lines, while the axis is neither focused nor defocused.

gridLine.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
gridLine.style.normal.strokeDashArray ​

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

  • Default: "5, 5"
  • Validation: should be a valid dash array or be equal to null
gridLine.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.13
  • Validation: should be a number >= to 0 and <= 1
gridLine.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

gridLine.visible ​

Whether to show grid lines perpendicular to each tick on the axis.

id ​

The unique identifier for the value axis so it can be referenced by series that belong to it.

Referenced by series[].axis (and seriesStacks[].axis) to assign series to this axis. With a single axis the ids can be omitted everywhere.

ignore ​

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

  • Default: false
  • Validation: should be a boolean

marginInner ​

The inner (closest to chart) margin (in pixels) of the axis.

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

marginOuter ​

The outer (furthest from chart) margin (in pixels) of the axis.

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

max ​

The forced maximum value for the axis: a number, or a date on a date category axis (use "auto" to compute from the values); must be >= min unless either is "auto" (set reversed to run the axis backwards).

With "auto" the maximum is computed from the data (including stacking) on every update, and changes animate through the staged axis expansion/contraction phases. Set a number to pin the bound instead. Values outside of the defined range are clipped rather than allowed to overflow the plot area of the chart.

maxMarginFraction ​

The margin, as a fraction (0 or greater) of the domain of the axis, to use at the maximum extent of the axis (only applied if max is "auto" and max value is not equal base).

The margin is relative to the pre-margin domain, so values above 1 are allowed and confine the data to a band of the plot: a margin of 4 leaves the data in the bottom fifth — how the candlestick/OHLC volume pane reserves the upper plot for the price axis.

maxOffset ​

The numeric offset to apply to the maximum value of the axis.

  • Default: 0
  • Validation: should be a number

maxTickCount ​

The maximum number of ticks to show along the length of the axis (use 0 to disable the maximum).

  • Default: 10
  • Validation: should be an integer and >= to 0

min ​

The forced minimum value for the axis: a number, or a date on a date category axis (use "auto" to compute from the values); must be <= max unless either is "auto" (set reversed to run the axis backwards).

With "auto" the minimum is computed from the data (including stacking) on every update, and changes animate through the staged axis expansion/contraction phases. Set a number to pin the bound instead. Values outside of the defined range are clipped rather than allowed to overflow the plot area of the chart.

minMarginFraction ​

The margin, as a fraction (0 or greater) of the domain of the axis, to use at the minimum extent of the axis (only applied if min is "auto" and min value is not equal base).

The margin is relative to the pre-margin domain, so values above 1 are allowed and confine the data to a band of the plot: a price axis with margin 1/3 keeps its data in the top three quarters, leaving the bottom for a volume pane.

minOffset ​

The numeric offset to apply to the minimum value of the axis.

  • Default: 0
  • Validation: should be a number

minTickInterval ​

The minimum value interval to use between any two consecutive tick label values.

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

minTickSpacing ​

The minimum space (in pixels) to allow between the bounds of any tick label text.

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

order ​

The unique integer order of the value axis controlling its order of appearance.

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

paddingInner ​

The inner (closest to chart) padding (in pixels) of the axis.

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

paddingOuter ​

The outer (furthest from chart) padding (in pixels) of the axis.

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

reversed ​

Whether the axis runs in the opposite direction, so its minimum is drawn where its maximum normally would be (an ordinal category axis reverses its category order).

scale ​

The scale of the value axis, must be linear.

  • Default: "linear"
  • Validation: should be equal to "linear"

side ​

Whether the axis is placed at the start (top/left) or end (bottom/right) of the chart.

softMax ​

The maximum value for the axis to cover while no data value is greater than it, taking the same forms as max (use null to disable).

An upper bound that only applies while no data value is above it — the axis covers at least this value, but real data larger than it still expands the domain. Unlike max, it never clips data.

softMin ​

The minimum value for the axis to cover while no data value is less than it, taking the same forms as min (use null to disable).

A lower bound that only applies while no data value is below it — the axis covers at least this value, but real data smaller than it still expands the domain. Unlike min, it never clips data.

thresholds ​

The threshold lines to draw on the axis, each an object drawing a reference line across the plot at an axis value (the array replaces the default wholesale).

thresholds[].front ​

Whether the line is drawn in front of (true) or behind (false) the series shapes.

  • Default: true
  • Validation: should be a boolean or be equal to undefined

thresholds[].style ​

The style of the threshold line.

thresholds[].style.defocused ​

The style of the threshold line, while the axis is defocused.

thresholds[].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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

  • Default: 0.325
  • Validation: should be a number >= to 0 and <= 1
thresholds[].style.defocused.strokeWidth ​

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

thresholds[].style.focused ​

The style of the threshold line, while the axis is focused.

thresholds[].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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

thresholds[].style.normal ​

The style of the threshold line, while the axis is neither focused nor defocused.

thresholds[].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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
thresholds[].style.normal.strokeDashArray ​

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

thresholds[].style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.65
  • Validation: should be a number >= to 0 and <= 1
thresholds[].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

thresholds[].title ​

The title label shown beside the threshold line.

thresholds[].title.backgroundStyle ​

The styles to apply to the threshold title background.

thresholds[].title.backgroundStyle.fillColor ​

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: null
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null
thresholds[].title.backgroundStyle.fillOpacity ​

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

  • Default: 0
  • Validation: should be a number >= to 0 and <= 1 or be equal to null
thresholds[].title.backgroundStyle.strokeColor ​

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null
thresholds[].title.backgroundStyle.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
thresholds[].title.backgroundStyle.strokeOpacity ​

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

  • Default: 0
  • Validation: should be a number >= to 0 and <= 1 or be equal to null
thresholds[].title.backgroundStyle.strokeWidth ​

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

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

thresholds[].title.margin ​

The margin (in pixels) of the threshold title, relative to its orientation.

  • Default: { top: 0, right: 0, bottom: 0, left: 0 }
  • Validation: should be an object with any of the properties { bottom, left, right, top } or be equal to undefined
thresholds[].title.margin.bottom ​

The space (in pixels) along the bottom edge.

  • Default: 0
  • Validation: should be a number >= to 0
thresholds[].title.margin.left ​

The space (in pixels) along the left edge.

  • Default: 0
  • Validation: should be a number >= to 0
thresholds[].title.margin.right ​

The space (in pixels) along the right edge.

  • Default: 0
  • Validation: should be a number >= to 0
thresholds[].title.margin.top ​

The space (in pixels) along the top edge.

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

thresholds[].title.padding ​

The padding (in pixels) of the threshold title, relative to its orientation.

  • Default: { top: 0, right: 0, bottom: 0, left: 0 }
  • Validation: should be an object with any of the properties { bottom, left, right, top } or be equal to undefined
  • Used in: Threshold Line
thresholds[].title.padding.bottom ​

The space (in pixels) along the bottom edge.

  • Default: 0
  • Validation: should be a number >= to 0
  • Used in: Threshold Line
thresholds[].title.padding.left ​

The space (in pixels) along the left edge.

  • Default: 0
  • Validation: should be a number >= to 0
  • Used in: Threshold Line
thresholds[].title.padding.right ​

The space (in pixels) along the right edge.

  • Default: 0
  • Validation: should be a number >= to 0
  • Used in: Threshold Line
thresholds[].title.padding.top ​

The space (in pixels) along the top edge.

  • Default: 0
  • Validation: should be a number >= to 0
  • Used in: Threshold Line

thresholds[].title.side ​

Which value side of the line the title sits on ("low" for smaller values, "high" for larger).

  • Default: "high"
  • Validation: should be one of [ "low", "high" ] or be equal to undefined
  • Used in: Threshold Line

thresholds[].title.snapToValue ​

Whether the title flips to the other side of the line when its own side has no room, instead of being clamped inside the plot over the line.

  • Default: true
  • Validation: should be a boolean or be equal to undefined
  • Used in: Threshold Line

thresholds[].title.text ​

The title text shown beside the line (use null for none).

thresholds[].title.textStyle ​

The style of the threshold title text.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { defocused, focused, normal } or be equal to undefined
thresholds[].title.textStyle.defocused ​

The style of the threshold title text, while the axis is defocused.

thresholds[].title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].title.textStyle.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
thresholds[].title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].title.textStyle.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

  • Default: null
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]
thresholds[].title.textStyle.focused ​

The style of the threshold title text, while the axis is focused.

thresholds[].title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].title.textStyle.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
thresholds[].title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
thresholds[].title.textStyle.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

  • Default: null
  • Validation: should be a number >= to 0 or be one of [ null, "same" ]
thresholds[].title.textStyle.normal ​

The style of the threshold title text, while the axis is neither focused nor defocused.

thresholds[].title.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
thresholds[].title.textStyle.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
thresholds[].title.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.

  • Default: "none"
  • Validation: should be a valid svg color (or "none" / "currentColor")
thresholds[].title.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
thresholds[].title.textStyle.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
thresholds[].title.textStyle.normal.strokeWidth ​

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

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

thresholds[].value ​

The axis value to draw the threshold line at (on a date category axis, a millisecond timestamp or ISO date string); thresholds never extend the axis domain, and a value outside it is not drawn.

tickCount ​

The number of ticks to show along the length of the axis (use "auto" to derive the tick count from the data).

  • Default: "auto"
  • Validation: should be an integer and >= to 0 or be equal to "auto"

tickLabel ​

The labels shown at each tick along the axis.

tickLabel.adjustSizeForFiltering ​

Whether to adjust the size of the axis tick label bounds as series belonging to it are filtered.

  • Default: false
  • Validation: should be a boolean

tickLabel.anchor ​

The anchor to use for all axis tick labels (start, end, middle) (use "auto" to determine automatically).

  • Default: "auto"
  • Validation: should be one of [ "start", "end", "middle", "auto" ]

tickLabel.backgroundStyle ​

The styles to apply to the axis tick label background (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).

tickLabel.backgroundStyle.fillColor ​

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: null
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

tickLabel.backgroundStyle.fillOpacity ​

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

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

tickLabel.backgroundStyle.strokeColor ​

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

tickLabel.backgroundStyle.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

tickLabel.backgroundStyle.strokeOpacity ​

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

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

tickLabel.backgroundStyle.strokeWidth ​

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

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

tickLabel.format ​

The d3 format string to be applied to the series values when displayed in axis tick labels (use null for none, use "auto" to derive from data).

tickLabel.front ​

Whether the axis tick labels should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

tickLabel.marginInner ​

The margin (in pixels) to show between the tick labels and the inside of the axis.

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

tickLabel.marginOuter ​

The margin (in pixels) to show between the tick labels and the outside of the axis.

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

tickLabel.paddingInner ​

The padding (in pixels) to show between the tick labels and the inside of the axis.

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

tickLabel.paddingOuter ​

The padding (in pixels) to show between the tick labels and the outside of the axis.

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

tickLabel.prefix ​

The string to prefix to the text of each axis tick label (use null for none).

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

tickLabel.rotation ​

The rotation (in degrees, -90 to 90) to apply to each axis tick label.

  • Default: 0
  • Validation: should be a number >= to -90 and <= 90
  • Used in: Rotated Ticks

tickLabel.size ​

The space (in pixels) perpendicular to the axis direction to allocate for the tick labels (use "auto" to derive from the font size).

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

tickLabel.suffix ​

The string to append to the text of each axis tick label (use null for none).

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

tickLabel.textStyle ​

The style of the axis tick label text.

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

tickLabel.textStyle.defocused ​

The style of the axis tick label text, while the axis is defocused.

tickLabel.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickLabel.textStyle.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
tickLabel.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickLabel.textStyle.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

tickLabel.textStyle.focused ​

The style of the axis tick label text, while the axis is focused.

tickLabel.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickLabel.textStyle.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
tickLabel.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickLabel.textStyle.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

tickLabel.textStyle.normal ​

The style of the axis tick label text, while the axis is neither focused nor defocused.

tickLabel.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
tickLabel.textStyle.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
tickLabel.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.

  • Default: "none"
  • Validation: should be a valid svg color (or "none" / "currentColor")
tickLabel.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
tickLabel.textStyle.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

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

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

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

tickMark ​

The tick marks drawn perpendicular to the axis at each tick value.

  • Default: { visible: true, front: false, size: 3, marginInner: 0, style: { … } }
  • Validation: should be an object with any of the properties { front, marginInner, size, style, visible }

tickMark.front ​

Whether the axis tick marks should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

tickMark.marginInner ​

The margin (in pixels) to show between the inside of the axis and the axis tick mark lines.

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

tickMark.size ​

The length (in pixels) of the axis tick mark lines.

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

tickMark.style ​

The style of the axis tick mark lines.

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

tickMark.style.defocused ​

The style of the axis tick mark lines, while the axis is defocused.

tickMark.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickMark.style.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

tickMark.style.focused ​

The style of the axis tick mark lines, while the axis is focused.

tickMark.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
tickMark.style.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

tickMark.style.normal ​

The style of the axis tick mark lines, while the axis is neither focused nor defocused.

tickMark.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
tickMark.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
tickMark.style.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

  • Default: 0.65
  • Validation: should be a number >= to 0 and <= 1
tickMark.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

tickMark.visible ​

Whether to show lines perpendicular to each tick value along the axis.

  • Default: true
  • Validation: should be a boolean

ticks ​

The explicit ticks to show on the axis in place of the generated ones, each placing label text at an axis value (use null for none).

Replaces the automatic tick generation entirely: tick counts, intervals and domain-edge ticks are ignored. Useful for naming fixed positions, e.g. heatmap row bands or threshold levels. Ticks outside the current axis domain are hidden.

  • Default: null
  • Validation: should be an array with elements that should be an object with exact properties { label, value } or be equal to null
  • Used in: Heatmap

ticks[].label ​

The text of the tick label (leave it out to format the value with tickLabel.format).

  • Default: none
  • Validation: should be a string or be equal to undefined
  • Used in: Heatmap

ticks[].value ​

The axis value to place the tick at.

  • Required: a value must be given (there is no default)
  • Validation: should be a number
  • Used in: Heatmap

title ​

The title shown alongside the axis.

title.backgroundStyle ​

The styles to apply to the axis title background (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).

title.backgroundStyle.fillColor ​

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: null
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

title.backgroundStyle.fillOpacity ​

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

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

title.backgroundStyle.strokeColor ​

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

title.backgroundStyle.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

title.backgroundStyle.strokeOpacity ​

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

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

title.backgroundStyle.strokeWidth ​

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

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

title.front ​

Whether the axis title should be shown in front (true) or behind (false) the series shapes.

  • Default: false
  • Validation: should be a boolean

title.marginInner ​

The margin (in pixels) to show between the axis title and the inside of the axis.

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

title.marginOuter ​

The margin (in pixels) to show between the axis title and the outside of the axis.

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

title.paddingInner ​

The padding (in pixels) to show between the axis title and the inside of the axis.

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

title.paddingOuter ​

The padding (in pixels) to show between the axis title and the outside of the axis.

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

title.size ​

The space (in pixels) perpendicular to the axis direction to allocate for the axis title (use "auto" to derive from the font size).

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

title.text ​

The title text to be shown alongside the axis (use null for no title).

title.textStyle ​

The style of the axis title text.

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

title.textStyle.defocused ​

The style of the axis title text, while the axis is defocused.

title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
title.textStyle.defocused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
title.textStyle.defocused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

title.textStyle.focused ​

The style of the axis title text, while the axis is focused.

title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
title.textStyle.focused.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
title.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 "same" to use the color of the normal state.

  • Default: "same"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to "same"
title.textStyle.focused.strokeDashArray ​

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke, or "same" to use the value of the normal state.

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

The opacity (0 - 1) of the stroke.

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

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset, or "same" to use the value of the normal state.

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

title.textStyle.normal ​

The style of the axis title text, while the axis is neither focused nor defocused.

title.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.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor")
title.textStyle.normal.fillOpacity ​

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
title.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.

  • Default: "none"
  • Validation: should be a valid svg color (or "none" / "currentColor")
title.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
title.textStyle.normal.strokeOpacity ​

The opacity (0 - 1) of the stroke.

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

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

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

title.truncation ​

The truncation applied to the axis title when it would overflow the axis bounds.

title.truncation.enabled ​

Whether to apply text truncation to the contents of the axis title when it would overflow the axis bounds.

title.truncation.text ​

The truncation text to append when text is truncated.

title.truncation.tooltipEnabled ​

Whether truncated text shows its full string as the browser’s native tooltip while a pointer rests on it.

When true, a truncated axis title carries an svg <title> holding the full text, which browsers show as their native tooltip (not the chart tooltip) while a mouse or pen rests on it. Touch has no hover, so nothing shows there; the axis group is already named from the full title.

  • Default: true
  • Validation: should be a boolean

type ​

The type of the value axis, must be number.

  • Default: "number"
  • Validation: should be equal to "number"

useSeriesFocus ​

Whether to show the axis as focused when any series belonging to it is focused.

  • Default: true
  • Validation: should be a boolean

visible ​

Whether the axis should be visible (its line, tick marks, tick labels and title). Its grid, base and threshold lines are controlled by their own visibility properties, and can remain visible when the axis is hidden.

  • Default:
    • false — when chart.type is pie
    • true — when chart.type is xy
  • Validation: should be equal to false when chart type is not xy; should be a boolean when chart type is xy
  • Used in: Sparklines · Volume pane · Picket Fence Bars · Candlestick

visibleWhenAllFiltered ​

Whether the axis should be visible when all series belonging to it are filtered.

  • Default: true
  • Validation: should be a boolean

Released under the MIT License.