Category Axis Config
Configure the chart category axis content and styling.
- Validation: should be an object with any of the properties {
axisLine,backgroundFront,backgroundStyle,categoryCountPadding,categoryPaddingFraction,categoryValueInterval,collapsed,dateUTC,focusRange,focusTickMark,gridLine,keyProperty,marginInner,marginOuter,max,maxOffset,maxTickCount,min,minCategoryValueExtent,minOffset,minTickInterval,minTickSpacing,minorGridLine,minorTickLabel,minorTickMark,paddingInner,paddingOuter,property,reversed,scale,side,softMax,softMin,thresholdStep,thresholds,tickCount,tickLabel,tickMark,tickStep,ticks,title,type,valueFormat,valueLabel,valuePrefix,valueSuffix,visible}
Every property is optional and falls back to its default, except property, which must be given. Property anchors are stable: link to any entry as #categoryAxis.propertyName, and to a member of a nested property as #categoryAxis.propertyName.memberName.
A property holding a list of objects documents the members of one entry, headed thresholds[].front. Their anchors leave the brackets out: #categoryAxis.thresholds.front.
axisLine
The line drawn along the length of the axis.
- Default:
{ visible: true, front: false, marginInner: 0, style: { … } } - Validation: should be an object with any of the properties {
front,marginInner,style,visible} - Used in: Multiple Axes · Picket Fence Bars · Curved Lines · +1 more
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.
- Default:
0 - Validation:
should be a number >= to 0 - Used in: Multiple Axes · Picket Fence Bars · Curved Lines · +1 more
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.
- Default:
{ strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.325 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.65 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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.
- Default:
true - Validation:
should be a boolean - Used in: Multiple Axes · Picket Fence Bars · Curved Lines · +1 more
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 {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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 slot count added to the number of category slots when dividing the category extent among them (one slot per category on an ordinal axis, one per categoryValueInterval on a linear or log axis).
- 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,outer} - Used in: 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.
categoryValueInterval
The axis value distance one category slot covers on a linear scale: a number in axis values, or on a date axis a millisecond count or one of second, minute, hour, day, week (use "auto" for the smallest gap between neighbouring categories, which on a log axis, where only "auto" is accepted, is the smallest ratio between them).
The slot decides how much room a category takes: a bar spans one slot less the outer padding fraction, grouped series share one slot, and categoryCountPadding adds slots to the divided extent. With "auto" the slot is the smallest gap between neighbouring category values, so evenly spaced data fills the axis the way an ordinal axis does and a missing category shows as an empty slot; with one category the slot is the whole domain. Set it when the data spacing is not the slot you want: "day" keeps daily bars a day wide when one day carries two samples, and a value smaller than the spacing draws narrower bars with space between them. A value wider than the spacing overlaps the bars. An ordinal axis has one category per slot, so there it must stay "auto". A log axis must stay "auto" too: its slot is the smallest ratio between neighbouring category values, so values a fixed ratio apart (1, 10, 100, or frequencies an octave apart) keep half a slot at each end of the axis, as evenly spaced values do on a linear axis.
- Default:
"auto" - Validation:
should be a number greater than 0 or be one of [ "auto", "second", "minute", "hour", "day", "week" ] when scale is linear and type is date;should be a number greater than 0 or be equal to "auto" when scale is linear and type is number;should be equal to "auto" when scale is log;should be equal to "auto"
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).
- Default:
true - Validation:
should be a boolean - Used in: Staged animation · Multiple Axes · Picket Fence Bars · Curved Lines · +1 more
focusRange
The band drawn over the axis at its focused series domain or category value.
- Default:
{ visible: false, 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.
- 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 {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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:
false - Validation:
should be a boolean
focusTickMark
The tick marks drawn perpendicular to the axis at its focused series domain or category value.
- Default:
{ visible: true, 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).
- Default:
{ strokeColor: "currentColor", strokeOpacity: 1, strokeWidth: 3, strokeDashArray: null } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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:
true - Validation:
should be a boolean
gridLine
The grid lines drawn across the plot at each tick on the axis.
- Default:
{ visible: false, front: false, style: { … } } - Validation: should be an object with any of the properties {
front,style,visible} - Used in: Date axis · Picket Fence Bars · Missing Values · Missing Pos/Neg Stacked Values · +3 more
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} - Used in: Missing Pos/Neg Stacked Values
gridLine.style.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,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.09 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 0.17, strokeWidth: "same", strokeDashArray: "same" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.17 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0.13, strokeWidth: 1, strokeDashArray: "5, 5" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Missing Pos/Neg Stacked Values
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 - Used in: Missing Pos/Neg Stacked Values
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 - Used in: Missing Pos/Neg Stacked Values
gridLine.visible
Whether to show grid lines perpendicular to each tick on the axis (false hides the minor grid lines too, whatever minorGridLine.visible says).
- Default:
false - Validation:
should be a boolean - Used in: Date axis · Picket Fence Bars · Missing Values · Missing Pos/Neg Stacked Values · +3 more
keyProperty
The property to retrieve from the data provider for the category keys, when the category values may repeat (use null for none).
When set, this property's values (strings or numbers, one per category) identify the categories instead of the category values themselves: they must be unique, and they are what animation, focus and filtering match categories by across data changes. Use it when the category values would otherwise repeat, such as a label keyed by an id, or a wall-clock date whose real instants repeat.
- Default:
null - Validation:
should be a string naming a data property or be equal to null - Used in: Truncated Text
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).
The form the bound takes follows type on a linear axis: a number when type is number, and either a millisecond timestamp or an ISO date string ("2020-01-01") when type is date (the two forms thresholds[].value takes). On a log axis it is a number above 0. An ordinal axis places its categories in data order, so it accepts only "auto".
- 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 a number greater than 0 or be equal to "auto" when scale is log;should be equal to "auto" when scale is ordinal - Used in: Missing Pos/Neg Stacked Values · Clipped Values
maxOffset
The offset to add to the maximum value of the axis while max is "auto" (no effect with a fixed max), in the axis's units: milliseconds on a date axis; must be 0 on a log axis, where a fixed amount of axis units takes a different length at each end (a value axis reserves space there with maxMarginFraction).
- Default:
0 - Validation:
should be a number when scale is linear;should be equal to 0 when scale is log;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 linear10: when scale is log0: when scale is ordinal
- Validation:
should be an integer and >= to 0 - Used in: Fewer ticks instead
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).
The form the bound takes follows type on a linear axis: a number when type is number, and either a millisecond timestamp or an ISO date string ("2020-01-01") when type is date (the two forms thresholds[].value takes). On a log axis it is a number above 0. An ordinal axis places its categories in data order, so it accepts only "auto".
- 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 a number greater than 0 or be equal to "auto" when scale is log;should be equal to "auto" when scale is ordinal;should not be above the max property of the same axis - Used in: Missing Pos/Neg Stacked Values · Clipped 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 offset to add to the minimum value of the axis while min is "auto" (no effect with a fixed min), in the axis's units: milliseconds on a date axis; must be 0 on a log axis, where a fixed amount of axis units takes a different length at each end (a value axis reserves space there with minMarginFraction).
- Default:
0 - Validation:
should be a number when scale is linear;should be equal to 0 when scale is log;should be equal to 0 when scale is ordinal
minTickInterval
The minimum value interval to use between any two consecutive tick label values (must be 0 on a log axis, whose ticks are powers of 10 rather than a fixed distance apart).
- Default:
0 - Validation:
should be equal to 0 when scale is log;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 linear12: when scale is log4: when scale is ordinal
- Validation:
should be a number >= to 0 - Used in: Fewer ticks instead
minorGridLine
The grid lines drawn across the plot at each minor tick on the axis.
- Default:
{ front: "major", style: { … } } - Validation: should be an object with any of the properties {
front,style,visible}
minorGridLine.front
Whether the minor grid lines should be shown in front (true) or behind (false) the series shapes ("major" uses the value of gridLine.front).
- Default:
"major" - Validation:
should be a boolean or be equal to "major"
minorGridLine.style
The style of the minor grid lines.
- Default:
{ normal: { … }, focused: { … }, defocused: { … } } - Validation: should be an object with any of the properties {
defocused,focused,normal}
minorGridLine.style.defocused
The style of the minor grid lines, while the axis is defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorGridLine.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 ("major" uses the value of gridLine.style.defocused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorGridLine.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 ("major" uses the value of gridLine.style.defocused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorGridLine.style.defocused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of gridLine.style.defocused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorGridLine.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 ("major" uses the value of gridLine.style.defocused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorGridLine.style.focused
The style of the minor grid lines, while the axis is focused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorGridLine.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 ("major" uses the value of gridLine.style.focused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorGridLine.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 ("major" uses the value of gridLine.style.focused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorGridLine.style.focused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of gridLine.style.focused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorGridLine.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 ("major" uses the value of gridLine.style.focused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorGridLine.style.normal
The style of the minor grid lines, while the axis is neither focused nor defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorGridLine.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 ("major" uses the value of gridLine.style.normal.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "major"
minorGridLine.style.normal.strokeDashArray
The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke ("major" uses the value of gridLine.style.normal.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be equal to null or be equal to "major"
minorGridLine.style.normal.strokeOpacity
The opacity (0 - 1) of the stroke ("major" uses the value of gridLine.style.normal.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "major"
minorGridLine.style.normal.strokeWidth
The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset ("major" uses the value of gridLine.style.normal.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to null or be equal to "major"
minorGridLine.visible
Whether to show grid lines perpendicular to each minor tick on the axis ("major" uses the value of gridLine.visible).
- Default:
"major": when scale is logfalse: when minorTickLabel.format is "major" and ticks is null"major": when minorTickLabel.format is set or ticks is set
- Validation:
should be a boolean or be equal to "major"
minorTickLabel
The labels shown at each minor tick along the axis.
A minor tick is one a tickStep places between its own ticks (the categories between an ordinal step's ticks, the minorSteps or minorInterval ticks of a linear step), one a log axis places at the multiples from 2 to 9 that are not ticks or at the powers of 10 it skips, or a ticks entry marked minor. Each member is named after the tickLabel member it stands in for, and "major" uses the value of that tickLabel member. Every member defaults to "major" except these: visible, whose default depends on minorTickLabel.format, ticks and scale; prefix and suffix, which default to null and take no "major"; and the text of the category axis truncation, which is always a string of its own. tickLabel.visible: false hides the minor tick labels too, whatever minorTickLabel.visible says.
- Default:
{ front: "major", anchor: "major", backgroundStyle: { … }, size: "major", marginInner: "major", marginOuter: "major", paddingInner: "major", paddingOuter: "major", format: "major", prefix: null, suffix: null, rotation: "major", textStyle: { … }, font: { … }, truncation: { … } } - Validation: should be an object with any of the properties {
anchor,backgroundStyle,font,format,front,marginInner,marginOuter,paddingInner,paddingOuter,prefix,rotation,size,suffix,textStyle,truncation,visible} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.anchor
The anchor to use for all minor tick labels (start, end, middle) (use "auto" to determine automatically) ("major" uses the value of tickLabel.anchor).
- Default:
"major" - Validation:
should be one of [ "start", "end", "middle", "auto", "major" ]
minorTickLabel.backgroundStyle
The styles to apply to the minor tick label background (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major", fillColor: "major", fillOpacity: "major" } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorTickLabel.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 ("major" uses the value of tickLabel.backgroundStyle.fillColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to null or be equal to "major"
minorTickLabel.backgroundStyle.fillOpacity
The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset ("major" uses the value of tickLabel.backgroundStyle.fillOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to null or be equal to "major"
minorTickLabel.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 ("major" uses the value of tickLabel.backgroundStyle.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to null or be equal to "major"
minorTickLabel.backgroundStyle.strokeDashArray
The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke ("major" uses the value of tickLabel.backgroundStyle.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be equal to null or be equal to "major"
minorTickLabel.backgroundStyle.strokeOpacity
The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset ("major" uses the value of tickLabel.backgroundStyle.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to null or be equal to "major"
minorTickLabel.backgroundStyle.strokeWidth
The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset ("major" uses the value of tickLabel.backgroundStyle.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to null or be equal to "major"
minorTickLabel.font
The font of the minor tick label text (family, size, weight, style), each member taking the matching tickLabel.font member when "major" and falling back to chart.font when null.
- Default:
{ family: "major", size: "major", weight: "major", style: "major" } - Validation: should be an object with any of the properties {
family,size,style,weight} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.font.family
The css font-family of the text, or null to leave the font family to css ("major" uses the value of tickLabel.font.family).
- Default:
"major" - Validation:
should be a css font-family string with at least one character other than whitespace or be equal to null or be equal to "major"
minorTickLabel.font.size
The font size of the text, as a number of pixels or any css font-size string (a length with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function), or null to leave the font size to css ("major" uses the value of tickLabel.font.size).
A relative size such as "0.85em" resolves against the font size the label inherits from the host page, as every font size in mochart does, not against tickLabel.font.size or chart.font.size: with tickLabel.font.size 16 on a page with a 12px font, "0.85em" gives minor labels 10.2px, not 13.6px.
- Default:
"major" - Validation:
should be a number of pixels greater than 0, or a css font-size string (a length above 0 with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function) or be equal to null or be equal to "major" - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.font.style
The css font-style of the text ("normal", "italic", "oblique"), or null to leave the font style to css ("major" uses the value of tickLabel.font.style).
- Default:
"major" - Validation:
should be one of [ "normal", "italic", "oblique" ] or be equal to null or be equal to "major"
minorTickLabel.font.weight
The css font-weight of the text (100 to 900 in hundreds, or "normal", "bold", "lighter", "bolder"), or null to leave the font weight to css ("major" uses the value of tickLabel.font.weight).
- Default:
"major" - Validation:
should be one of [ 100, 200, 300, 400, 500, 600, 700, 800, 900, "normal", "bold", "lighter", "bolder" ] or be equal to null or be equal to "major"
minorTickLabel.format
The d3 format string (d3-format for number, d3-time-format for date) to be applied to the category values when displayed in minor tick labels (use null for none, use "auto" to derive from data) ("major" uses the value of tickLabel.format).
"major" is replaced with the value of tickLabel.format before any formatter is built, so it never reaches d3.
- Default:
"major" - Validation:
should be one of [ null, "auto", "major" ] when type is string;should be a valid date format or be one of [ null, "auto", "major" ] when type is date;should be a valid number format or be one of [ null, "auto", "major" ] when type is number - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.front
Whether the minor tick labels should be shown in front (true) or behind (false) the series shapes ("major" uses the value of tickLabel.front).
- Default:
"major" - Validation:
should be a boolean or be equal to "major"
minorTickLabel.marginInner
The margin (in pixels) to show between the minor tick labels and the inside of the axis ("major" uses the value of tickLabel.marginInner).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickLabel.marginOuter
The margin (in pixels) to show between the minor tick labels and the outside of the axis ("major" uses the value of tickLabel.marginOuter).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickLabel.paddingInner
The padding (in pixels) to show between the minor tick labels and the inside of the axis ("major" uses the value of tickLabel.paddingInner).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickLabel.paddingOuter
The padding (in pixels) to show between the minor tick labels and the outside of the axis ("major" uses the value of tickLabel.paddingOuter).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickLabel.prefix
The string to prefix to the text of each minor tick label (use null or an empty string for none).
- Default:
null - Validation:
should be a string or be equal to null
minorTickLabel.rotation
The rotation (in degrees, -90 to 90) to apply to each minor tick label ("major" uses the value of tickLabel.rotation).
- Default:
"major" - Validation:
should be a number >= to -90 and <= 90 or be equal to "major"
minorTickLabel.size
The space (in pixels) perpendicular to the axis direction to allocate for the minor tick labels (use "auto" to derive from the font size) ("major" uses the value of tickLabel.size).
The minor labels have a layout of their own: they are measured and placed from the minorTickLabel settings, the axis reserves the larger of the two label totals (size, margins and paddings), the title sits after the larger one, and the minor labels get their own background box.
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ "auto", "major" ]
minorTickLabel.suffix
The string to append to the text of each minor tick label (use null or an empty string for none).
- Default:
null - Validation:
should be a string or be equal to null
minorTickLabel.textStyle
The style of the minor tick label text.
- Default:
{ normal: { … }, focused: { … }, defocused: { … } } - Validation: should be an object with any of the properties {
defocused,focused,normal} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.textStyle.defocused
The style of the minor tick label text, while the axis is defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major", fillColor: "major", fillOpacity: "major" } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.defocused.fillColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickLabel.textStyle.defocused.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state ("major" uses the value of tickLabel.textStyle.defocused.fillOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major" - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.defocused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.defocused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorTickLabel.textStyle.defocused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of tickLabel.textStyle.defocused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.defocused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorTickLabel.textStyle.focused
The style of the minor tick label text, while the axis is focused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major", fillColor: "major", fillOpacity: "major" } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.focused.fillColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickLabel.textStyle.focused.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state ("major" uses the value of tickLabel.textStyle.focused.fillOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major" - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.focused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.focused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorTickLabel.textStyle.focused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of tickLabel.textStyle.focused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.focused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorTickLabel.textStyle.normal
The style of the minor tick label text, while the axis is neither focused nor defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major", fillColor: "major", fillOpacity: "major" } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.normal.fillColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "major"
minorTickLabel.textStyle.normal.fillOpacity
The opacity (0 - 1) of the fill ("major" uses the value of tickLabel.textStyle.normal.fillOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "major" - Used in: Candlestick · OHLC bars · Hollow Candlestick · OHLC Bars
minorTickLabel.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 ("major" uses the value of tickLabel.textStyle.normal.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "major"
minorTickLabel.textStyle.normal.strokeDashArray
The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke ("major" uses the value of tickLabel.textStyle.normal.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be equal to null or be equal to "major"
minorTickLabel.textStyle.normal.strokeOpacity
The opacity (0 - 1) of the stroke ("major" uses the value of tickLabel.textStyle.normal.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "major"
minorTickLabel.textStyle.normal.strokeWidth
The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset ("major" uses the value of tickLabel.textStyle.normal.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to null or be equal to "major"
minorTickLabel.truncation
The truncation applied to the minor tick labels when they would overlap each other.
Truncating the minor labels never shortens the non-minor labels, whose truncation counts only their own ticks.
- Default:
{ enabled: "major", text: "…", tooltipEnabled: "major", minLength: "major", maxFraction: "major" } - Validation: should be an object with any of the properties {
enabled,maxFraction,minLength,text,tooltipEnabled}
minorTickLabel.truncation.enabled
Whether or not to use text truncation (true) when the minor tick labels would overlap each other instead of hiding them (false) ("major" uses the value of tickLabel.truncation.enabled).
- Default:
"major" - Validation:
should be one of [ false, "major" ] when scale is linear;should be one of [ false, "major" ] when scale is log;should be a boolean or be equal to "major"
minorTickLabel.truncation.maxFraction
The maximum fraction (0 - 1) of the plot bounds to allow any minor tick label text to occupy when they are perpendicular to the axis ("major" uses the value of tickLabel.truncation.maxFraction).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "major"
minorTickLabel.truncation.minLength
The minimum length (in pixels) to allow minor tick label text perpendicular to the axis, applied when maxFraction would allow less ("major" uses the value of tickLabel.truncation.minLength).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickLabel.truncation.text
The truncation text to append when minor tick label text is truncated.
- Default:
"…" - Validation:
should be a string
minorTickLabel.truncation.tooltipEnabled
Whether truncated minor tick label text shows its full string as the browser's native tooltip while a pointer rests on it ("major" uses the value of tickLabel.truncation.tooltipEnabled).
When true, a truncated minor tick label 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.
- Default:
"major" - Validation:
should be a boolean or be equal to "major"
minorTickLabel.visible
Whether to show the minor tick labels, the labels of the minor ticks a tickStep places between its ticks, a log axis places at the multiples and skipped powers of 10 that are not ticks, and of the ticks entries marked minor ("major" uses the value of tickLabel.visible).
The default is false while minorTickLabel.format is "major" and ticks is unset, so a tickStep alone labels only its own ticks; setting minorTickLabel.format or listing ticks turns it to "major", except that on a log axis only listing ticks does. A log axis makes its minor ticks without being asked, so there minorTickMark.visible and minorGridLine.visible default to "major" while this stays false, which shows their marks and grid lines without crowding the axis with labels; minorTickLabel.format alone does not turn it on there, since minor labels that do not fit would hide the marks and grid lines with them. Minor labels never change which non-minor labels show. A minor label shows only when every minor label fits beside its neighbours, minor or not, measured from the widest minor and non-minor labels plus minTickSpacing; when one does not fit they all hide, unless the category axis minorTickLabel.truncation truncates them instead. Minor labels that do not fit hide their tick marks and grid lines with them; false here hides only the labels and takes them out of the layout, and tickLabel.visible: false hides the minor labels whatever this says.
- Default:
false: when minorTickLabel.format is "major" and ticks is nullfalse: when scale is log and ticks is null"major": when minorTickLabel.format is set or ticks is set
- Validation:
should be a boolean or be equal to "major"
minorTickMark
The tick marks drawn perpendicular to the axis at each minor tick value.
- Default:
{ front: "major", size: "major", marginInner: "major", style: { … } } - Validation: should be an object with any of the properties {
front,marginInner,size,style,visible}
minorTickMark.front
Whether the minor tick marks should be shown in front (true) or behind (false) the series shapes ("major" uses the value of tickMark.front).
- Default:
"major" - Validation:
should be a boolean or be equal to "major"
minorTickMark.marginInner
The margin (in pixels) to show between the inside of the axis and the minor tick mark lines ("major" uses the value of tickMark.marginInner).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickMark.size
The length (in pixels) of the minor tick mark lines ("major" uses the value of tickMark.size).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to "major"
minorTickMark.style
The style of the minor tick mark lines.
- Default:
{ normal: { … }, focused: { … }, defocused: { … } } - Validation: should be an object with any of the properties {
defocused,focused,normal}
minorTickMark.style.defocused
The style of the minor tick mark lines, while the axis is defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorTickMark.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 ("major" uses the value of tickMark.style.defocused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickMark.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 ("major" uses the value of tickMark.style.defocused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorTickMark.style.defocused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of tickMark.style.defocused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorTickMark.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 ("major" uses the value of tickMark.style.defocused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorTickMark.style.focused
The style of the minor tick mark lines, while the axis is focused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorTickMark.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 ("major" uses the value of tickMark.style.focused.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "same" or be equal to "major"
minorTickMark.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 ("major" uses the value of tickMark.style.focused.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be one of [ null, "same" ] or be equal to "major"
minorTickMark.style.focused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state ("major" uses the value of tickMark.style.focused.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "same" or be equal to "major"
minorTickMark.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 ("major" uses the value of tickMark.style.focused.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be one of [ null, "same" ] or be equal to "major"
minorTickMark.style.normal
The style of the minor tick mark lines, while the axis is neither focused nor defocused.
- Default:
{ strokeColor: "major", strokeOpacity: "major", strokeWidth: "major", strokeDashArray: "major" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
minorTickMark.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 ("major" uses the value of tickMark.style.normal.strokeColor).
- Default:
"major" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to "major"
minorTickMark.style.normal.strokeDashArray
The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke ("major" uses the value of tickMark.style.normal.strokeDashArray).
- Default:
"major" - Validation:
should be a valid dash array or be equal to null or be equal to "major"
minorTickMark.style.normal.strokeOpacity
The opacity (0 - 1) of the stroke ("major" uses the value of tickMark.style.normal.strokeOpacity).
- Default:
"major" - Validation:
should be a number >= to 0 and <= 1 or be equal to "major"
minorTickMark.style.normal.strokeWidth
The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset ("major" uses the value of tickMark.style.normal.strokeWidth).
- Default:
"major" - Validation:
should be a number >= to 0 or be equal to null or be equal to "major"
minorTickMark.visible
Whether to show lines perpendicular to each minor tick value along the axis ("major" uses the value of tickMark.visible).
- Default:
"major": when scale is logfalse: when minorTickLabel.format is "major" and ticks is null"major": when minorTickLabel.format is set or ticks is set
- Validation:
should be a boolean or be equal to "major"
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: the values must match type, they position a linear axis, and they are what tick labels and the tooltip show. They must be unique unless keyProperty is set. It is required: the only category axis property without a default.
- Required: a value must be given (there is no default)
- Validation:
should be a string naming a data property - Used in: Home · Getting started · Staged animation · Stacked · Grouped · Grouped Across Axes · +67 more
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).
- Default:
false - Validation:
should be a boolean
scale
The scale to use for the category values: ordinal for any type, linear for number and date values, log for number values.
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; log positions number category values by ratio, so 1 to 10 takes the same length as 100 to 1000, for log-log plots such as a frequency response. A log axis has no position for 0 or a negative value, so category values at or below 0 are a data error; it rejects bar series, whose widths are a fixed distance in values, and takes no offsets, minTickInterval or step interval for the same reason. Its ticks sit at the powers of 10 and, where they fit, their 2 and 5 or 2 to 9 multiples, with the rest as minor ticks. A date axis cannot be log, since a date has no natural zero; elapsed time on a log axis is a number, such as days since an event. A pie chart's category axis accepts "ordinal" or "linear", not "log".
- Default:
"ordinal" - Validation:
should be equal to "ordinal" when type is string;should be one of [ "linear", "ordinal" ] when chart type is not xy;should be one of [ "linear", "ordinal" ] when type is date;should be one of [ "linear", "log", "ordinal" ] when type is number;should be one of [ "linear", "ordinal" ] - Used in: Home · Getting started · Staged animation · Stacked · Grouped · Grouped Across Axes · +65 more
side
Whether the axis is placed at the start (top/left) or end (bottom/right) of the chart.
- Default:
"start": when plot.inverted is true"end": when plot.inverted is false
- Validation:
should be one of [ "start", "end" ] - Used in: Multiple Axes · Picket Fence Bars · Curved Lines · +2 more
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).
Takes the same forms as max (a number, above 0 on a log axis, or a timestamp or ISO date string on a date axis) but only applies while no category value rises above it, so real data still expands the domain. An ordinal axis accepts only null.
- 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 a number greater than 0 or be equal to null when scale is log;should be equal to null when scale is ordinal
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).
Takes the same forms as min (a number, above 0 on a log axis, or a timestamp or ISO date string on a date axis) but only applies while no category value falls below it, so real data still expands the domain. An ordinal axis accepts only null.
- 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 a number greater than 0 or be equal to null when scale is log;should be equal to null when scale is ordinal;should not be above the softMax property of the same axis
thresholdStep
Threshold lines or ranges repeated along the axis by rule.
The steps follow the scale and interval: on an ordinal axis the categories, so every: 2 stripes alternate categories, or with a period as the interval the first category of each period; on a linear date axis the boundaries of a period interval or the multiples of a number interval in milliseconds; on a linear number axis the multiples of the interval number; and on a linear axis with no interval, or a log axis, which never takes one, nothing is drawn. A linear scale counts its periods from a fixed calendar origin and its multiples from 0, or on a date axis from the epoch (local midnight of the epoch day when dateUTC is false), so the same steps keep their shapes as the data moves the domain. The stepped thresholds draw after the thresholds entries and carry no title; on a linear axis minSpacing keeps a rule from flooding the axis.
- Default:
{ visible: false, interval: null, every: 1, offset: 0, minSpacing: 2, range: true, front: false, style: { … }, pattern: null, gradient: null } - Validation: should be an object with any of the properties {
every,front,gradient,interval,minSpacing,offset,pattern,range,style,visible} - Used in: Threshold Step
thresholdStep.every
Which steps get a threshold: 1 keeps every step, 2 every other one, 3 every third.
every means the same in tickStep and thresholdStep. On a linear axis every and offset need an interval to count, so setting either without one is a validation error, and offset shifts which steps every keeps, so setting it while every is 1 (every step kept) is one too. A log axis takes no interval, so setting either there is a validation error too.
- Default:
1 - Validation:
should be an integer and >= to 1;should be left at its default on a linear axis unless interval is set;should be left at its default on a log axis, where interval must be null - Used in: Threshold Step
thresholdStep.front
Whether the stepped thresholds are drawn in front of (true) or behind (false) the series shapes.
- Default:
false - Validation:
should be a boolean
thresholdStep.gradient
The unique id of the gradient config filling the stepped ranges (use null for none; an unknown id is a validation error; cannot be combined with pattern).
- Default:
null - Validation:
should be a string or be equal to null;should be the id of a linearGradients or radialGradients entry
thresholdStep.interval
The distance the thresholds step by: a number, in axis values on a linear number axis or in milliseconds on a linear date axis, or a calendar period (second, minute, hour, day, week, month, year) on a date axis (use null for none, as a log axis must).
A number steps by its multiples: in axis values counted from 0 on a number axis, and in milliseconds counted from the epoch on a linear date axis, or from local midnight of the epoch day when dateUTC is false, so 90 * 60 * 1000 with every: 2 draws a range over every other 90 minutes. The multiples keep a fixed length, so with dateUTC false a daylight saving change moves them an hour against the local clock, which a period does not. A period steps by the calendar: weeks start on Monday and the boundaries follow dateUTC. On an ordinal axis the steps are the first category of each period, so "week" with every: 2 draws a range over every other week whatever the holidays; on a linear date axis they are the period boundaries themselves. An ordinal date axis takes only a period.
- Default:
null - Validation:
should be a number greater than 0 or be one of [ null, "second", "minute", "hour", "day", "week", "month", "year" ] when scale is linear and type is date;should be one of [ "second", "minute", "hour", "day", "week", "month", "year" ] or be equal to null when type is date;should be a number greater than 0 or be equal to null when scale is linear and type is number;should be equal to null when scale is log;should be equal to null - Used in: Threshold Step
thresholdStep.minSpacing
The least distance (in pixels, at least 2) to allow between the thresholds the rule draws on a linear axis; when they would be closer, none are drawn (an ordinal axis accepts only 2).
The thresholds are counted before any is drawn, from the axis length and the number of thresholds the rule would draw, so a rule that would flood the axis never builds its shapes. When they would sit closer together than minSpacing, no stepped thresholds are drawn and a console warning names the axis. An ordinal axis never draws more thresholds than it has categories, so it accepts only the default.
- Default:
2 - Validation:
should be a number >= to 2 when scale is linear;should be a number >= to 2 when scale is log;should be equal to 2 when scale is ordinal
thresholdStep.offset
The number of steps skipped before the first threshold; on a linear scale it shifts which multiples or periods are kept, counted from 0 or the calendar origin.
every means the same in tickStep and thresholdStep. On a linear axis every and offset need an interval to count, so setting either without one is a validation error, and offset shifts which steps every keeps, so setting it while every is 1 (every step kept) is one too. A log axis takes no interval, so setting either there is a validation error too.
- Default:
0 - Validation:
should be an integer and >= to 0;should be left at its default on a linear axis unless interval is set;should be left at its default on a log axis, where interval must be null;should be 0 on a linear axis unless every is above 1, since all steps are kept and there is nothing to shift
thresholdStep.pattern
The unique id of the pattern config filling the stepped ranges (use null for none; an unknown id is a validation error; cannot be combined with gradient).
The pattern's "owner" color keyword resolves to the step's style.normal.fillColor.
- Default:
null - Validation:
should be a string or be equal to null;should be the id of a patterns entry;cannot be combined with gradient - Used in: Threshold Step
thresholdStep.range
Whether each threshold is a range spanning its step (true) or a line at its start (false).
On an ordinal axis a range covers whole slots from its step to the category before the next candidate step; on a linear axis it spans from the step to the next one. A line sits at the step itself.
- Default:
true - Validation:
should be a boolean
thresholdStep.style
The style of the stepped thresholds: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line.
- Default:
{ normal: { … }, focused: { … }, defocused: { … } } - Validation: should be an object with any of the properties {
defocused,focused,normal} - Used in: Threshold Step
thresholdStep.style.defocused
The style of the stepped thresholds: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is defocused.
- Default:
{ strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same", fillColor: "same", fillOpacity: 0.05 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
thresholdStep.style.defocused.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "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"
thresholdStep.style.defocused.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state.
- Default:
0.05 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
thresholdStep.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"
thresholdStep.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" ]
thresholdStep.style.defocused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state.
- Default:
0.325 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
thresholdStep.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" ]
thresholdStep.style.focused
The style of the stepped thresholds: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is focused.
- Default:
{ strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same", fillColor: "same", fillOpacity: 0.1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
thresholdStep.style.focused.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "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"
thresholdStep.style.focused.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state.
- Default:
0.1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
thresholdStep.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"
thresholdStep.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" ]
thresholdStep.style.focused.strokeOpacity
The opacity (0 - 1) of the stroke, or "same" to use the value of the normal state.
- Default:
0.65 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
thresholdStep.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" ]
thresholdStep.style.normal
The style of the stepped thresholds: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is neither focused nor defocused.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 0.1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Threshold Step
thresholdStep.style.normal.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color.
- Default:
"currentColor" - Validation:
should be a valid svg color (or "none" / "currentColor")
thresholdStep.style.normal.fillOpacity
The opacity (0 - 1) of the fill.
- Default:
0.1 - Validation:
should be a number >= to 0 and <= 1 - Used in: Threshold Step
thresholdStep.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")
thresholdStep.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
thresholdStep.style.normal.strokeOpacity
The opacity (0 - 1) of the stroke.
- Default:
0.65 - Validation:
should be a number >= to 0 and <= 1 - Used in: Threshold Step
thresholdStep.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
thresholdStep.visible
Whether to draw the stepped thresholds.
- Default:
false - Validation:
should be a boolean - Used in: Threshold Step
thresholds
The thresholds to draw across the plot: a line at an axis value, or a range between two.
A line at a category or axis value, or with a rangeValue a range between two. A line entry uses only the style stroke members; the fill members, pattern and gradient apply to ranges. Thresholds never extend the axis domain: a line outside it is not drawn, a range partly outside is clipped to it, and one wholly outside is not drawn. On a log axis a value at or below 0 has no position: a line there is a validation error, a range with one end there fills from the minimum end of the axis (a range from 0 to 10 covers everything below 10), and a range with neither end above 0 is a validation error.
- Default:
[] - Validation: should be an array with elements that should be an object with exact properties {
front,gradient,pattern,rangeValue,style,title,value} - Used in: Thresholds and ranges · Threshold Step
thresholds[].front
Whether the threshold 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[].gradient
The unique id of the gradient config filling a threshold range (use null for none; an unknown id is a validation error; cannot be combined with pattern).
- Default:
null - Validation:
should be a string or be one of [ null, undefined ];should be the id of a linearGradients or radialGradients entry
thresholds[].pattern
The unique id of the pattern config filling a threshold range (use null for none; an unknown id is a validation error; cannot be combined with gradient).
The pattern's "owner" color keyword resolves to the range's style.normal.fillColor.
- Default:
null - Validation:
should be a string or be one of [ null, undefined ];should be the id of a patterns entry;cannot be combined with gradient
thresholds[].rangeValue
The second value of a threshold range (use null for a line).
Turns the entry into a range: the space between the two values (in either order) is filled with the style fill members, or with the pattern or gradient named by id, and its two edges are drawn with the stroke members like lines (a stroke opacity of 0 leaves the fill alone). On an ordinal axis the range covers whole slots, from the outer edge of the lower positioned of the two named categories to the outer edge of the higher, so ranges over consecutive weeks tile without gaps; a range with either end naming a category the data does not hold is not drawn, since an ordinal axis has no position to clip it to.
- Default:
null - Validation:
should be a number or be one of [ null, undefined ]
thresholds[].style
The style of the threshold: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line.
- Default:
{ normal: { … }, focused: { … }, defocused: { … } } - Validation: should be an object with any of the properties {
defocused,focused,normal} or be equal to undefined
thresholds[].style.defocused
The style of the threshold: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is defocused.
- Default:
{ strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same", fillColor: "same", fillOpacity: 0.05 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
thresholds[].style.defocused.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "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.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state.
- Default:
0.05 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
0.325 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is focused.
- Default:
{ strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same", fillColor: "same", fillOpacity: 0.1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
thresholds[].style.focused.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color, or "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.fillOpacity
The opacity (0 - 1) of the fill, or "same" to use the value of the normal state.
- Default:
0.1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
0.65 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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: the stroke members draw a line or the edges of a range, the fill members fill a range and are ignored on a line, while the axis is neither focused nor defocused.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 0.1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
thresholds[].style.normal.fillColor
The color of the fill: use "none" to switch the fill off, or "currentColor" to follow the host page's css color.
- Default:
"currentColor" - Validation:
should be a valid svg color (or "none" / "currentColor")
thresholds[].style.normal.fillOpacity
The opacity (0 - 1) of the fill.
- Default:
0.1 - Validation:
should be a number >= to 0 and <= 1
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.
- Default:
null - Validation:
should be a valid dash array or be equal to null
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.
- Default:
{ text: null, side: "high", anchor: "auto", snapToValue: true, margin: { … }, padding: { … }, textStyle: { … }, font: { … }, backgroundStyle: { … } } - Validation: should be an object with any of the properties {
anchor,backgroundStyle,font,margin,padding,side,snapToValue,text,textStyle} or be equal to undefined - Used in: Thresholds and ranges · Threshold Step
thresholds[].title.anchor
Where the title sits along the threshold ("start", "middle", "end", or "auto" for the axis side).
- Default:
"auto" - Validation:
should be one of [ "start", "end", "middle" ] or be one of [ "auto", undefined ] - Used in: Threshold Step
thresholds[].title.backgroundStyle
The styles to apply to the threshold title background.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} or be equal to undefined
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.font
The font of the threshold title text (family, size, weight, style), each member falling back to chart.font when null.
- Default:
{ family: null, size: null, weight: null, style: null } - Validation: should be an object with any of the properties {
family,size,style,weight} or be equal to undefined
thresholds[].title.font.family
The css font-family of the text, or null to leave the font family to css.
- Default:
null - Validation:
should be a css font-family string with at least one character other than whitespace or be equal to null
thresholds[].title.font.size
The font size of the text, as a number of pixels or any css font-size string (a length with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function), or null to leave the font size to css.
- Default:
null - Validation:
should be a number of pixels greater than 0, or a css font-size string (a length above 0 with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function) or be equal to null
thresholds[].title.font.style
The css font-style of the text ("normal", "italic", "oblique"), or null to leave the font style to css.
- Default:
null - Validation:
should be one of [ "normal", "italic", "oblique" ] or be equal to null
thresholds[].title.font.weight
The css font-weight of the text (100 to 900 in hundreds, or "normal", "bold", "lighter", "bolder"), or null to leave the font weight to css.
- Default:
null - Validation:
should be one of [ 100, 200, 300, 400, 500, 600, 700, 800, 900, "normal", "bold", "lighter", "bolder" ] 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
thresholds[].title.padding.bottom
The space (in pixels) along the bottom edge.
- Default:
0 - Validation:
should be a number >= to 0
thresholds[].title.padding.left
The space (in pixels) along the left edge.
- Default:
0 - Validation:
should be a number >= to 0
thresholds[].title.padding.right
The space (in pixels) along the right edge.
- Default:
0 - Validation:
should be a number >= to 0
thresholds[].title.padding.top
The space (in pixels) along the top edge.
- Default:
0 - Validation:
should be a number >= to 0
thresholds[].title.side
The value side of the threshold the title sits on ("low", "high", or "inside" a range).
On a line, the side of the line the title sits on, by axis value. On a range, low or high of the whole range, or inside centered within it; inside is an error on a line.
- Default:
"high" - Validation:
should be one of [ "low", "high", "inside" ] or be equal to undefined;should be "inside" only on a threshold range (an entry with a rangeValue)
thresholds[].title.snapToValue
Whether the title flips to the other side of the threshold when its own side has no room, instead of being clamped inside the plot over it.
- Default:
true - Validation:
should be a boolean or be equal to undefined
thresholds[].title.text
The title text shown beside the threshold (use null or an empty string for none).
- Default:
null - Validation:
should be a string or be one of [ null, undefined ] - Used in: Thresholds and ranges · Threshold Step
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.
- Default:
{ strokeColor: "same", strokeOpacity: 1, strokeWidth: null, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 1, strokeWidth: null, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "none", strokeOpacity: 1, strokeWidth: null, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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 the threshold sits at: on an ordinal axis a category (or its key, with a keyProperty), on a linear or log axis a number, or a millisecond timestamp or ISO date string when type is date.
On a linear or log axis it takes the same forms as min: a number when type is number, and either a millisecond timestamp or an ISO date string when type is date. On an ordinal axis it names a category, matched the way explicit ticks are (a date by instant, so the ISO and timestamp forms both find a Date category; the category string on a string axis; the key when the axis has a keyProperty), and a line sits at the category's center. An entry naming no category is not drawn.
- Required: a value must be given (there is no default)
- Validation:
should be a string or should be a number when scale is ordinal and keyProperty is set;should be an iso date string or epoch number when type is date;should be a string when type is string;should be a number;should be a number greater than 0 when scale is log;should be a number greater than 0 when scale is log and rangeValue is not greater than 0 - Used in: Thresholds and ranges · Threshold Step
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
tickLabel
The labels shown at each tick along the axis.
- Default:
{ visible: true, front: false, anchor: "auto", backgroundStyle: { … }, size: "auto", marginInner: 2, marginOuter: 1, paddingInner: 5, paddingOuter: 5, format: "auto", prefix: null, suffix: null, rotation: 0, textStyle: { … }, font: { … }, truncation: { … } } - Validation: should be an object with any of the properties {
anchor,backgroundStyle,font,format,front,marginInner,marginOuter,paddingInner,paddingOuter,prefix,rotation,size,suffix,textStyle,truncation,visible} - Used in: Date axis · Tooltip formatting · Staged animation · Multiple Axes · Log value axis · Threshold Step · +13 more
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)).
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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.font
The font of the axis tick label text (family, size, weight, style), each member falling back to chart.font when null.
- Default:
{ family: null, size: null, weight: null, style: null } - Validation: should be an object with any of the properties {
family,size,style,weight} - Used in: Font
tickLabel.font.family
The css font-family of the text, or null to leave the font family to css.
- Default:
null - Validation:
should be a css font-family string with at least one character other than whitespace or be equal to null
tickLabel.font.size
The font size of the text, as a number of pixels or any css font-size string (a length with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function), or null to leave the font size to css.
- Default:
null - Validation:
should be a number of pixels greater than 0, or a css font-size string (a length above 0 with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function) or be equal to null
tickLabel.font.style
The css font-style of the text ("normal", "italic", "oblique"), or null to leave the font style to css.
- Default:
null - Validation:
should be one of [ "normal", "italic", "oblique" ] or be equal to null
tickLabel.font.weight
The css font-weight of the text (100 to 900 in hundreds, or "normal", "bold", "lighter", "bolder"), or null to leave the font weight to css.
- Default:
null - Validation:
should be one of [ 100, 200, 300, 400, 500, 600, 700, 800, 900, "normal", "bold", "lighter", "bolder" ] or be equal to null - Used in: Font
tickLabel.format
The d3 format string (d3-format for number, d3-time-format for date) to be applied to the category values when displayed in axis tick labels (use null for none, use "auto" to derive the format from the ticks: on a number axis an SI-prefixed number whose precision follows the tick spacing, or on a log axis the magnitude of each tick, in exponent form beyond the SI prefixes; there a format that leaves its precision open takes 3 significant digits, trimmed).
- 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 · Tooltip formatting · Staged animation · Multiple Axes · Log value axis · Threshold Step · +12 more
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 - Used in: Fewer ticks instead
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 or an empty string 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: Tick labels · Rotated Ticks · Picket Fence Bars
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 or an empty string 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} - Used in: Fewer ticks instead
tickLabel.textStyle.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 {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.5 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
0.5 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "none", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Fewer ticks instead
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 - Used in: Fewer ticks instead
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
tickLabel.truncation
The truncation applied to the axis tick labels when they would overlap each other.
- Default:
{ text: "…", tooltipEnabled: true, minLength: 0, maxFraction: 0.2 } - Validation: should be an object with any of the properties {
enabled,maxFraction,minLength,text,tooltipEnabled} - Used in: Tick labels · Truncated Text
tickLabel.truncation.enabled
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 stringfalse: when type is not string
- Validation:
should be equal to false when scale is linear;should be equal to false when scale is log;should be a boolean - Used in: Tick labels · Truncated Text
tickLabel.truncation.maxFraction
The maximum fraction (0 - 1) of the plot 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: Tick labels · Truncated Text
tickLabel.truncation.minLength
The minimum length (in pixels) to allow tick label text perpendicular to the axis, applied when maxFraction would allow less.
- Default:
0 - Validation:
should be a number >= to 0 - Used in: Tick labels
tickLabel.truncation.text
The truncation text to append when text is truncated.
- Default:
"…" - Validation:
should be a string - Used in: Tick labels · Truncated Text
tickLabel.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 tick label 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; assistive tech already gets the full text through aria-label.
- Default:
true - Validation:
should be a boolean
tickLabel.visible
Whether to show the axis tick labels (false hides the minor tick labels too, whatever minorTickLabel.visible says).
A label hidden here is not drawn and takes no room in the layout, and its ticks are no longer thinned to make the labels fit: under a tickStep rule the tick marks and grid lines are limited only by tickStep.minSpacing, and without one the axis still picks its tick count from tickCount, maxTickCount, minTickSpacing and minTickInterval. To keep hidden labels in the layout, leave them visible and set the opacities of every state of textStyle to 0 instead.
- Default:
true - Validation:
should be a boolean
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.
- Default:
{ strokeColor: "same", strokeOpacity: 0.325, strokeWidth: "same", strokeDashArray: "same" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.325 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 0.65, strokeWidth: "same", strokeDashArray: "same" } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.65 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0.65, strokeWidth: 1, strokeDashArray: null } - Validation: should be an object with any of the properties {
strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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 (false hides the minor tick marks too, whatever minorTickMark.visible says).
- Default:
true - Validation:
should be a boolean
tickStep
The step between the ticks shown along the axis, with minor ticks between them.
Chooses the ticks by rule rather than by a list, so the choice holds as the data changes; explicit ticks take precedence. On an ordinal axis the candidates are the categories in order, or with a period as the interval the first category of each period, every and offset step through them, and the categories between the ticks are minor ticks. On a linear axis interval places the ticks at the multiples of a number, in axis values on a number axis and in milliseconds on a date axis, or on the boundaries of a period on a date axis; every and offset choose which of them are kept, counted from a fixed starting point, and minorInterval (date axis) or minorSteps (number axis) places minor ticks between them; without an interval the axis keeps the ticks it picks. A log axis takes no interval, since equal distances in values take unequal lengths there, so it always keeps the ticks it picks. The minor tick marks, grid lines and labels carry the mochart-axis-minor-tick-mark, mochart-axis-minor-grid-line and mochart-axis-minor-tick-label classes, and minorTickLabel, minorTickMark and minorGridLine say how they are drawn.
- Default:
{ interval: null, every: 1, offset: 0, minorSteps: null, minSpacing: 2, minorInterval: null, includeFirst: false } - Validation: should be an object with any of the properties {
every,includeFirst,interval,minSpacing,minorInterval,minorSteps,offset} - Used in: Date axis · Candlestick · OHLC bars · Threshold Step · Hollow Candlestick · Candlestick, log price axis · +1 more
tickStep.every
Which steps get a tick: 1 keeps every step, 2 every other one, 3 every third.
Counts through the candidates, the categories or the period starts: every: 5, offset: 3 shows the fourth category and every fifth after it, and interval: "week" with every: 2 gives every second week. When more ticks survive the rule than fit, every k-th survivor is kept starting from the first, so thinned Mondays stay Mondays; tickLabel.truncation still decides whether crowded labels truncate or skip. It means the same in tickStep and thresholdStep. On a linear axis it needs an interval to count, and is counted from a fixed starting point, so setting it without one is a validation error. A log axis takes no interval, so setting it there is one too.
- Default:
1 - Validation:
should be an integer and >= to 1;should be left at its default on a linear axis unless interval is set;should be left at its default on a log axis, where interval must be null
tickStep.includeFirst
Whether the first category always gets a tick, even when every and offset would skip it (ordinal scale only; a linear or log axis accepts only false).
- Default:
false - Validation:
should be a boolean when scale is ordinal;should be equal to false when scale is linear;should be equal to false when scale is log
tickStep.interval
The distance between the ticks: a number, in axis values on a linear number axis or in milliseconds on a linear date axis, or a calendar period (second, minute, hour, day, week, month, year) on a date axis (use null to keep the ticks the axis picks, as a log axis must).
A number places a tick at every multiple of it inside the axis domain, so the ticks stay put as the data moves the domain. On a number axis the number is in axis values and the multiples are counted from 0. On a linear date axis it is in milliseconds and the multiples are counted from the epoch, 1 January 1970 00:00 UTC, or from local midnight of that day when dateUTC is false, so 12 * 60 * 60 * 1000 places a tick at every midnight and noon. The multiples keep a fixed length, so with dateUTC false a daylight saving change moves them an hour against the local clock, which a period does not. Setting it never changes the automatic min and max of the axis, it only chooses where the ticks go. On a number axis a tickLabel.format without a precision of its own, "auto" included, takes its precision from the spacing of the ticks drawn: an interval of 0.25 reads 0.25, a minorSteps of 4 on an interval of 1 reads 0.25 too, and a spacing with no exact decimal form, such as a minorSteps of 3 on an interval of 1, reads to two significant digits: 0.33, 0.67. When more ticks survive than fit, every k-th survivor is kept from the first, and a tick thinned away stays a hidden tick: its minor ticks are kept, and it never becomes one. A period steps by the calendar: a week starts on Monday and the boundaries follow dateUTC, so a daily series with "week" gets a tick at each week's first trading day whatever the holidays. A partial first week is a period of its own, so its first category gets a tick too; offset: 1 skips it. On a linear date axis the ticks sit on the period boundaries themselves. An ordinal date axis takes only a period, since its ticks are categories rather than positions a number of milliseconds could step through.
- Default:
null - Validation:
should be a number greater than 0 or be one of [ null, "second", "minute", "hour", "day", "week", "month", "year" ] when scale is linear and type is date;should be one of [ "second", "minute", "hour", "day", "week", "month", "year" ] or be equal to null when type is date;should be a number greater than 0 or be equal to null when scale is linear and type is number;should be equal to null when scale is log;should be equal to null - Used in: Date axis · Candlestick · OHLC bars · Threshold Step · Hollow Candlestick · Candlestick, log price axis · +1 more
tickStep.minSpacing
The least distance (in pixels, at least 2) to allow between the ticks the step creates on a linear axis; minor ticks that would be closer are not created, and ticks that would be closer leave the axis to the ticks it picks (an ordinal axis accepts only 2).
The ticks are counted before any is created, from the axis length and the number the step would create, so a step that would create thousands of ticks never builds them. When the minor ticks would be closer together than this, none are created; when the ticks themselves would be, the step creates none either and the axis uses the ticks it picks, as if interval were null. Both cases log a console warning naming the axis. Explicit ticks are never limited, and an ordinal axis cannot create more ticks than it has categories, so it accepts only the default.
- Default:
2 - Validation:
should be a number >= to 2 when scale is linear;should be a number >= to 2 when scale is log;should be equal to 2 when scale is ordinal
tickStep.minorInterval
The distance between the minor ticks placed between the ticks on a linear date axis, in the form interval takes: a number of milliseconds smaller than a number interval, or a calendar period (second, minute, hour, day, week, month, year) shorter than a period interval (use null for none).
Takes the form interval takes, so mixing a number and a period is a validation error. With a period interval it must be a shorter period: a week inside a month, a day inside a week, or an hour inside a day. With a number interval it must be a smaller number of milliseconds, counted from the same origin as the ticks, and need not divide interval evenly: { interval: 6 * 60 * 60 * 1000, minorInterval: 60 * 60 * 1000 } gives a minor tick every hour between ticks six hours apart. A minor tick on a tick the step keeps is dropped, and one closer to a tick than minorInterval is hidden with its tick mark and grid line: a tick inside a minor period hides the minor ticks at both ends of that period, such as the Mondays either side of the 1st of a month, and a tick on a minor boundary hides none.
- Default:
null - Validation:
should be a number greater than 0 or be one of [ null, "second", "minute", "hour", "day", "week", "month", "year" ] when scale is linear and type is date;should be equal to null;should be null unless interval is set;should be a period when interval is a period;should be a number when interval is a number;should be a shorter period than interval;should be smaller than interval
tickStep.minorSteps
The number of even steps (at least 2) each interval is split into on a linear number scale, with a minor tick at each step between the ticks (use null for none).
Splits interval itself, not the gap between the ticks that every keeps, and needs an interval to split. { interval: 10, every: 2, minorSteps: 5 } gives ticks at 0, 20 and 40 and minor ticks every 2, including at 10 and 30: the steps every skips get a minor tick only where one of the even steps falls. A minor tick at a tick's position is dropped.
- Default:
null - Validation:
should be an integer and >= to 2 or be equal to null when scale is linear and type is number;should be equal to null when scale is log;should be equal to null;should be null unless interval is set
tickStep.offset
The number of steps skipped before the first tick; on a linear scale it shifts which multiples or periods are kept, counted from 0 or the calendar origin.
Counted in candidates, so with a period as the interval an offset of 1 skips the first period rather than the first category. On a linear axis it needs an interval to count, so setting it without one is a validation error, and a log axis takes no interval, so setting it there is one too. It shifts which steps every keeps, so setting it while every is 1 (every step kept) is also an error.
- Default:
0 - Validation:
should be an integer and >= to 0;should be left at its default on a linear axis unless interval is set;should be left at its default on a log axis, where interval must be null;should be 0 on a linear axis unless every is above 1, since all steps are kept and there is nothing to shift
ticks
The explicit ticks to show on the axis in place of the generated ones, each placing label text at a category value (use null for none).
Replaces the automatic tick generation entirely: tick counts, intervals and the tick skipping that keeps labels apart are ignored, so the configured ticks show even where they overlap, except that the entries marked minor follow the minor label fit rule. Useful for naming chosen categories with label text of their own; for a regular pattern such as one tick a week, use tickStep. Two entries naming the same category (compared the way a tick finds its category: by instant on a date axis, by key with a keyProperty, otherwise by value) are a validation error.
- Default:
null - Validation: should be an array with elements that should be an object with exact properties {
label,minor,value} or be equal to null - Used in: Date axis
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
ticks[].minor
Whether the tick is a minor tick, drawn and labeled with the minor tick settings (leave it out for a regular tick).
A minor entry is drawn with the minorTickLabel, minorTickMark and minorGridLine settings, and its label shows only when every minor label fits beside its neighbours; an entry with a label keeps it whatever minorTickLabel.format says.
- Default: none
- Validation:
should be a boolean or be equal to undefined
ticks[].value
The category to place the tick at, named by its value (the category string on a string axis, a number on a number axis, a millisecond timestamp or ISO date string on a date axis) or, on an ordinal axis with a keyProperty, by its key.
Takes the same forms as min on a linear or log axis: a number when type is number, and either a millisecond timestamp or an ISO date string when type is date; on a string axis it is the category string. On an ordinal axis the tick shows at the category whose value matches (a date matches by instant, so the ISO and timestamp forms both find a Date category), or with a keyProperty at the category whose key matches, since the key is what makes a repeated value unique; a tick matching no category is hidden. On a linear or log axis the tick is placed on the scale, and one outside the current axis domain is hidden.
- Required: a value must be given (there is no default)
- Validation:
should be a string or should be a number when scale is ordinal and keyProperty is set;should be a number greater than 0 when scale is log;should be a string when type is string;should be an iso date string or epoch number when type is date;should be a number when type is number;should not repeat the value of another ticks entry - Used in: Date axis
title
The title shown alongside the axis.
- Default:
{ text: null, front: false, backgroundStyle: { … }, truncation: { … }, size: "auto", marginInner: 2, marginOuter: 2, paddingInner: 3, paddingOuter: 3, textStyle: { … }, font: { … } } - Validation: should be an object with any of the properties {
backgroundStyle,font,front,marginInner,marginOuter,paddingInner,paddingOuter,size,text,textStyle,truncation} - Used in: Histogram · Log category axes · Curves · Multiple Axes · Log-log axes · Truncated Text · +11 more
title.backgroundStyle
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 {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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.font
The font of the axis title text (family, size, weight, style), each member falling back to chart.font when null.
- Default:
{ family: null, size: null, weight: null, style: null } - Validation: should be an object with any of the properties {
family,size,style,weight} - Used in: Font
title.font.family
The css font-family of the text, or null to leave the font family to css.
- Default:
null - Validation:
should be a css font-family string with at least one character other than whitespace or be equal to null
title.font.size
The font size of the text, as a number of pixels or any css font-size string (a length with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function), or null to leave the font size to css.
- Default:
null - Validation:
should be a number of pixels greater than 0, or a css font-size string (a length above 0 with a unit, a percentage, a size keyword, or a calc/clamp/min/max/var function) or be equal to null - Used in: Font
title.font.style
The css font-style of the text ("normal", "italic", "oblique"), or null to leave the font style to css.
- Default:
null - Validation:
should be one of [ "normal", "italic", "oblique" ] or be equal to null - Used in: Font
title.font.weight
The css font-weight of the text (100 to 900 in hundreds, or "normal", "bold", "lighter", "bolder"), or null to leave the font weight to css.
- Default:
null - Validation:
should be one of [ 100, 200, 300, 400, 500, 600, 700, 800, 900, "normal", "bold", "lighter", "bolder" ] 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 or an empty string for no title).
- Default:
null - Validation:
should be a string or be equal to null - Used in: Histogram · Log category axes · Curves · Multiple Axes · Log-log axes · Truncated Text · +11 more
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.
- 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 {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
0.5 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
0.5 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "same", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: "same", fillColor: "same", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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, or "same" to use the value of the normal state.
- Default:
1 - Validation:
should be a number >= to 0 and <= 1 or be equal to "same"
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.
- Default:
{ strokeColor: "none", strokeOpacity: 1, strokeWidth: 0, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 1 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth}
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.
- Default:
{ enabled: true, text: "…", tooltipEnabled: true } - Validation: should be an object with any of the properties {
enabled,text,tooltipEnabled} - Used in: Truncated Text
title.truncation.enabled
Whether to apply text truncation to the contents of the axis title when it would overflow the axis bounds.
- Default:
true - Validation:
should be a boolean - Used in: Truncated Text
title.truncation.text
The truncation text to append when text is truncated.
- Default:
"…" - Validation:
should be a string - Used in: Truncated Text
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 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.
- Default:
"string" - Validation:
should be one of [ "number", "date", "string" ] - Used in: Home · Getting started · Staged animation · Stacked · Grouped · Grouped Across Axes · +65 more
valueFormat
The d3 format string (d3-format for number, d3-time-format for date) 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: Date axis · Tooltip formatting · Log scales · Log value axis · Log-log axes · Threshold Step · +8 more
valueLabel
The label to show before a category value in the tooltip (use null or an empty string for none).
- Default:
null - Validation:
should be a string or be equal to null - Used in: Stacked · Grouped · Grouped Across Axes · +27 more
valuePrefix
The text to prefix category values with when showing them in the tooltip (use null or an empty string 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 or an empty string for none).
- Default:
null - Validation:
should be a string or be equal to null - Used in: Log category axes · Log-log axes
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 pietrue: 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