Skip to content

Category Axis Config

Configure the chart category axis content and styling.

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

Properties

axisLineFront

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

  • Default: false
  • Validation: should be a boolean

axisLineMargin

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

axisLineStyle

The style of the line shown along the axis.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] } }

axisLineStyle.defocused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
axisLineStyle.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"
axisLineStyle.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" ]
axisLineStyle.defocused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

axisLineStyle.focused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
axisLineStyle.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"
axisLineStyle.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" ]
axisLineStyle.focused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

axisLineStyle.normal

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }
axisLineStyle.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")
axisLineStyle.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
axisLineStyle.normal.strokeOpacity

The opacity (0 - 1) of the stroke.

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

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }

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

categoryCountPadding

The extra count to be added to the category value count when dividing the category extent for displaying category values.

  • Default: 1
  • Validation: should be a number >= to 0
  • Used in: Bubble Chart

categoryPaddingFraction

The padding fractions (0 - 1) of the category extent for all category values (outer) and grouped series (inner).

  • Default: { inner: 0.1, outer: 0.1 }
  • Validation: should be an object with any of the properties { inner: should be a number >= to 0 and <= 1, outer: should be a number >= to 0 and <= 1 }
  • Used in: Histogram · Heatmap · Histogram · Heatmap

categoryPaddingFraction.inner

The fraction (0 - 1) of a category value's extent to leave as space between the series drawn inside it.

categoryPaddingFraction.outer

The fraction (0 - 1) to trim from each category value's extent, leaving space between neighbouring category values.

collapsed

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

  • Default: false
  • Validation: should be a boolean

dateUTC

Whether dates should be treated as UTC (true) or local (false).

displayProperty

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

When set, this property’s value is used wherever the category value is displayed (tick labels, tooltip), while property still drives positioning — useful for pre-formatted or friendly labels.

  • Default: null
  • Validation: should be a defined value or equal to null
  • Used in: Truncated Text

focusRangeApplyToTitle

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

focusRangeFront

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

  • Default: false
  • Validation: should be a boolean

focusRangeStyle

The style of the focus range.

  • Default: { strokeColor: "currentColor", strokeOpacity: 0.2, strokeWidth: 1, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 0.12 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }

focusRangeStyle.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")

focusRangeStyle.fillOpacity

The opacity (0 - 1) of the fill.

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

focusRangeStyle.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")

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

focusRangeStyle.strokeOpacity

The opacity (0 - 1) of the stroke.

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

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

focusTickMarkFront

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

  • Default: false
  • Validation: should be a boolean

focusTickMarkMargin

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

focusTickMarkSize

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

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

focusTickMarkStyle

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 1, strokeWidth: 3, strokeDashArray: null }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }

focusTickMarkStyle.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")

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

focusTickMarkStyle.strokeOpacity

The opacity (0 - 1) of the stroke.

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

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

gridLineFront

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

  • Default: false
  • Validation: should be a boolean

gridLineStyle

The style of the axis grid lines.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] } }
  • Used in: Missing Pos/Neg Stacked Values

gridLineStyle.defocused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.09, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
gridLineStyle.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"
gridLineStyle.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" ]
gridLineStyle.defocused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

gridLineStyle.focused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.17, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
gridLineStyle.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"
gridLineStyle.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" ]
gridLineStyle.focused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

gridLineStyle.normal

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0.13, strokeWidth: 1, strokeDashArray: "5, 5" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }
  • Used in: Missing Pos/Neg Stacked Values
gridLineStyle.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")
gridLineStyle.normal.strokeDashArray

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

gridLineStyle.normal.strokeOpacity

The opacity (0 - 1) of the stroke.

  • Default: 0.13
  • Validation: should be a number >= to 0 and <= 1
gridLineStyle.normal.strokeWidth

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

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 numeric value for the axis (use "auto" to compute from the values).

  • Default: "auto"
  • Validation: should be an iso date string or epoch number or be equal to "auto" when scale is linear and type is date; should be a number or be equal to "auto" when scale is linear and type is number; should be equal to "auto" when scale is ordinal
  • Used in: Missing Pos/Neg Stacked Values

maxOffset

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

  • Default: 0
  • Validation: should be a number when scale is linear; should be equal to 0 when scale is ordinal

maxTickCount

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

  • Default:
    • 10 — when scale is linear
    • 0 — when scale is ordinal
  • Validation: should be an integer and >= to 0

min

The forced minimum numeric value for the axis (use "auto" to compute from the values).

  • Default: "auto"
  • Validation: should be an iso date string or epoch number or be equal to "auto" when scale is linear and type is date; should be a number or be equal to "auto" when scale is linear and type is number; should be equal to "auto" when scale is ordinal
  • Used in: Missing Pos/Neg Stacked Values

minCategoryValueExtent

The minimum extent (in pixels) of each category slot; for a non-inverted bar chart this is a minimum bar width.

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

minOffset

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

  • Default: 0
  • Validation: should be a number when scale is linear; should be equal to 0 when scale is ordinal

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 — when scale is linear
    • 4 — when scale is ordinal
  • Validation: should be a number >= to 0

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

property

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

The chart reads this property from each entry of the data provider to get the category value. It is required — the only category axis property without a default.

scale

The scale to use for the displayed category values (ordinal, linear).

ordinal places the categories at evenly spaced positions in data order regardless of their values; linear positions number/date category values proportionally along the axis, so uneven spacing in the data shows as uneven spacing in the chart.

showAxisLine

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

showFocusRange

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

  • Default: false
  • Validation: should be a boolean

showFocusTickMarks

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

  • Default: true
  • Validation: should be a boolean

showGridLines

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

showTickMarks

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

  • Default: true
  • Validation: should be a boolean

side

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

softMax

The forced maximum numeric value for the axis to be used if no data value is greater than this value (use null to disable).

  • Default: null
  • Validation: should be an iso date string or epoch number or be equal to null when scale is linear and type is date; should be a number or be equal to null when scale is linear and type is number; should be equal to null when scale is ordinal

softMin

The forced minimum numeric value for the axis to be used if no data value is less than this value (use null to disable).

  • Default: null
  • Validation: should be an iso date string or epoch number or be equal to null when scale is linear and type is date; should be a number or be equal to null when scale is linear and type is number; should be equal to null when scale is ordinal

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

  • Default: []
  • Validation: should be an array with elements that should be an object with exact properties { value: should be an iso date string or epoch number, front: should be a boolean or be equal to undefined, style: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] } } or be equal to undefined, title: should be a string or be one of [ null, undefined ], titleSide: should be one of [ "low", "high" ] or be equal to undefined, titleSnapToValue: should be a boolean or be equal to undefined, titleMargin: should be an object with any of the properties { top: should be a number >= to 0, right: should be a number >= to 0, bottom: should be a number >= to 0, left: should be a number >= to 0 } or be equal to undefined, titlePadding: should be an object with any of the properties { top: should be a number >= to 0, right: should be a number >= to 0, bottom: should be a number >= to 0, left: should be a number >= to 0 } or be equal to undefined, titleTextStyle: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 } } or be equal to undefined, titleBackgroundStyle: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null } or be equal to undefined }

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"
  • Used in: Picket Fence Bars

tickLabelAnchor

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" ]

tickLabelBackgroundStyle

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }

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

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

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

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

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

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

tickLabelFormat

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

  • Default: "auto"
  • Validation: should be one of [ null, "auto" ] when type is string; should be a valid date format or be one of [ null, "auto" ] when type is date; should be a valid number format or be one of [ null, "auto" ] when type is number
  • Used in: Date axis · Multiple Axes · Rotated Ticks · Picket Fence Bars · +1 more

tickLabelFront

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

  • Default: false
  • Validation: should be a boolean

tickLabelMarginInner

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

tickLabelMarginOuter

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

tickLabelPaddingInner

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

tickLabelPaddingOuter

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

tickLabelPrefix

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

tickLabelRotation

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

tickLabelSize

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"

tickLabelSuffix

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

tickLabelTextStyle

The style of the axis tick label text.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 } }

tickLabelTextStyle.defocused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.5, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 0.5 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }
tickLabelTextStyle.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"
tickLabelTextStyle.defocused.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
tickLabelTextStyle.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"
tickLabelTextStyle.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" ]
tickLabelTextStyle.defocused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

tickLabelTextStyle.focused

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

  • Default: { strokeColor: "same", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }
tickLabelTextStyle.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"
tickLabelTextStyle.focused.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
tickLabelTextStyle.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"
tickLabelTextStyle.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" ]
tickLabelTextStyle.focused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

tickLabelTextStyle.normal

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

  • Default: { strokeColor: "none", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 1 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }
tickLabelTextStyle.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")
tickLabelTextStyle.normal.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
tickLabelTextStyle.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")
tickLabelTextStyle.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
tickLabelTextStyle.normal.strokeOpacity

The opacity (0 - 1) of the stroke.

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

tickLabelTruncationEnabled

Whether or not to use text truncation (true) when the axis tick labels would overlap each other instead of skipping ticks (false).

  • Default:
    • true — when type is string
    • false — when type is not string
  • Validation: should be equal to false when scale is linear; should be a boolean
  • Used in: Truncated Text

tickLabelTruncationMaxFraction

The maximum fraction (0 - 1) of the chart bounds to allow any tick label text to occupy when they are perpendicular to the axis.

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

tickLabelTruncationMinLength

The minimum length at which to apply tick label truncation if the maximum fraction setting is used.

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

tickLabelTruncationValue

The truncation text to append to the axis tick label text when its content is truncated.

tickMarkFront

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

  • Default: false
  • Validation: should be a boolean

tickMarkMargin

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

tickMarkSize

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

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

tickMarkStyle

The style of the axis tick mark lines.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] } }

tickMarkStyle.defocused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
tickMarkStyle.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"
tickMarkStyle.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" ]
tickMarkStyle.defocused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

tickMarkStyle.focused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same" }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ] }
tickMarkStyle.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"
tickMarkStyle.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" ]
tickMarkStyle.focused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

tickMarkStyle.normal

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }
tickMarkStyle.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")
tickMarkStyle.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
tickMarkStyle.normal.strokeOpacity

The opacity (0 - 1) of the stroke.

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

title

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

titleBackgroundStyle

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

  • Default: { strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null }

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

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

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

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

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

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

titleFront

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

  • Default: false
  • Validation: should be a boolean

titleMarginInner

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

titleMarginOuter

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

titlePaddingInner

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

titlePaddingOuter

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

titleSize

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"

titleTextStyle

The style of the axis title text.

  • Default: { normal: { … }, focused: { … }, defocused: { … } }
  • Validation: should be an object with any of the properties { normal: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }, focused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }, defocused: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 } }

titleTextStyle.defocused

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

  • Default: { strokeColor: "same", strokeOpacity: 0.5, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 0.5 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }
titleTextStyle.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"
titleTextStyle.defocused.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 0.5
  • Validation: should be a number >= to 0 and <= 1
titleTextStyle.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"
titleTextStyle.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" ]
titleTextStyle.defocused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

titleTextStyle.focused

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

  • Default: { strokeColor: "same", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be one of [ null, "same" ], strokeDashArray: should be a valid dash array or be one of [ null, "same" ], fillColor: should be a valid svg color (or "none" / "currentColor") or be equal to "same", fillOpacity: should be a number >= to 0 and <= 1 }
titleTextStyle.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"
titleTextStyle.focused.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
titleTextStyle.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"
titleTextStyle.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" ]
titleTextStyle.focused.strokeOpacity

The opacity (0 - 1) of the stroke.

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

titleTextStyle.normal

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

  • Default: { strokeColor: "none", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 1 }
  • Validation: should be an object with any of the properties { strokeColor: should be a valid svg color (or "none" / "currentColor"), strokeOpacity: should be a number >= to 0 and <= 1, strokeWidth: should be a number >= to 0 or be equal to null, strokeDashArray: should be a valid dash array or be equal to null, fillColor: should be a valid svg color (or "none" / "currentColor"), fillOpacity: should be a number >= to 0 and <= 1 }
titleTextStyle.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")
titleTextStyle.normal.fillOpacity

The opacity (0 - 1) of the fill.

  • Default: 1
  • Validation: should be a number >= to 0 and <= 1
titleTextStyle.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")
titleTextStyle.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
titleTextStyle.normal.strokeOpacity

The opacity (0 - 1) of the stroke.

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

titleTruncationEnabled

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

titleTruncationValue

The truncation text to append to the axis title when its length exceeds the bounds of the axis.

type

The type of the displayed category values (number, date, string).

How category values are interpreted: string for labels, number for numeric values, and date for date values (dateUTC controls their timezone handling). The type drives parsing, tick label formatting, and which scale options make sense.

valueFormat

The d3 format string to be applied to the category value when displayed in the tooltip (use null for none, use "auto" to derive from data).

  • Default: "auto"
  • Validation: should be one of [ null, "auto" ] when type is string; should be a valid date format or be one of [ null, "auto" ] when type is date; should be a valid number format or be one of [ null, "auto" ] when type is number
  • Used in: Picket Fence Bars

valueLabel

The label to show before a category value in the tooltip (use null for none).

valuePrefix

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

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

valueSuffix

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

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

visible

Whether the axis should be visible.

  • Default:
    • false — when chart.type is pie
    • true — when chart.type is xy
  • Validation: should be a boolean
  • Used in: Sparklines

Released under the BSD-3-Clause License.