Marquee Config

PropertyDescriptionValidation RulesDefaultDetails
animationConfigConfigure the chart animation settingsshould be an object{}Details
chartConfigConfigure general settings of the chartshould be an object{}Details
colorPaletteConfigConfigure the color palettes to use for collections of seriesshould be an object{}Details
crosshairConfigConfigure the crosshair styling and behavior when a group and/or series is focusedshould be an object{}Details
groupAxisConfigConfigure the chart group axis content and stylingshould be an object{}Details
legendConfigConfigure the chart legend which itemizes the seriesshould be an object{}Details
linearGradientConfigs
linearGradientAllConfig
Configure linear gradients to be applied to series
Configure common properties for all linear gradients
should be an array with elements that should be an object
should be an object
[]
{}
Details
plotConfigConfigure the chart plot content and stylingshould be an object{}Details
radialGradientConfigs
radialGradientAllConfig
Configure radial gradients to be applied to series
Configure common properties for all radial gradients
should be an array with elements that should be an object
should be an object
[]
{}
Details
seriesAxisConfigs
seriesAxisAllConfig
Configure the chart series axes content and styling
Configure common properties for all series axes
should be a non-empty array with elements that should be an object
should be an object
[]
{}
Details
seriesConfigs
seriesAllConfig
Configure the chart series
Configure common properties for all series
should be an array with elements that should be an object
should be an object
[]
{}
Details
seriesGroupConfigs
seriesGroupAllConfig
Configure the grouping of series
Configure common properties for all series groups
should be an array with elements that should be an object
should be an object
[]
{}
Details
seriesStackConfigs
seriesStackAllConfig
Configure the stacking of series
Configure common properties for all series stacks
should be an array with elements that should be an object
should be an object
[]
{}
Details
titleConfigConfigure the chart titleshould be an object{}Details
tooltipConfigConfigure the chart tooltip styling and behaviorshould be an object{}Details
versionThe version of the configuration formatshould be equal to "1.0.3"

Animation Config

PropertyDescriptionValidation RulesDefault
animatewhether all animation should be enabled or disabledshould be a boolean
true
collapseDurationthe maximum duration for the axis collapse animation phase when new data is removed from the chartshould be a number >= to 0
1000
expansionDurationthe maximum duration for the axis expansion animation phase when new data is added to the chartshould be a number >= to 0
1000
focusDurationthe duration of animation showing the transition between focus on a specific series or group valueshould be a number >= to 0
1000
initialDurationthe maximum duration for the initial animation when chart data is first loadedshould be a number >= to 0
1000
valueChangeDurationthe maximum duration for the value change animation phase when data in the chart changesshould be a number >= to 0
1000

Chart Config

PropertyDescriptionValidation RulesDefault
backgroundStylethe styles to apply to the chart background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
marginthe margin (in pixels) for the top, right, bottom and left sides of the chartshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 2 right: 2 bottom: 2 left: 2}
paddingthe padding (in pixels) for the top, right, bottom and left sides of the chartshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 3 right: 3 bottom: 3 left: 3}

Color Palette Config

PropertyDescriptionValidation RulesDefault
labelthe color palette to use for series labels that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
labelDefocusedthe color palette to use for defocused series labels that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
labelFocusedthe color palette to use for focused series labels that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
markerthe color palette to use for series markers that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
markerDefocusedthe color palette to use for defocused series markers that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
markerFocusedthe color palette to use for focused series markers that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
seriesthe color palette to use for series shapes that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
seriesDefocusedthe color palette to use for defocused series shapes that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }
seriesFocusedthe color palette to use for focused series shapes that are colored by series or group indexshould be an object with properties [ "strokeColors", "fillColors" ] all of which should be a non-empty array with elements that should be a valid color
{ strokeColors: fillColors: }

Crosshair Config

PropertyDescriptionValidation RulesDefault
applyFocuswhether to change the focused group as the crosshairs are shown or hiddenshould be a boolean
true
lineColorthe color to use when showing the crosshair linesshould be a valid svg color
lineDashArraythe dash array pattern to use when drawing the crosshair lines (use null for none)should be a valid dash array or be equal to null
"10, 5"
lineWidththe stroke width (in pixels) of the crosshair linesshould be a number >= to 0
3
showBehindTooltipwhether to show the crosshair lines for sections where they are overlapped by the tooltipshould be a boolean
false
showGroupwhether or not crosshair lines for focused groups should be shownshould be a boolean
true
showSerieswhether or not crosshair lines for focused series should be shownshould be a boolean
true
visiblewhether or not crosshairs should be shown when a group or series is focusedshould be a boolean
true

Group Axis Config

PropertyDescriptionValidation RulesDefault
axisLinewhether to show a line along the length of the axisshould be a boolean
true
axisLineColorthe color of the line shown along the axisshould be a valid svg color
axisLineDashArraythe dash array pattern to use when drawing the line shown along the axis (use null for none)should be a valid dash array or be equal to null
null
axisLineMarginthe margin (in pixels) between the line shown along the axis and the inner boundary of the axisshould be a number >= to 0
0
axisLineOpacitythe opacity (0 - 1) of the line shown along the axisshould be a number >= to 0 and <= 1
1
axisLineWidththe stroke width (in pixels) of the line shown along the axisshould be a number >= to 0
1
beforewhether the axis should be position before (top/left) or after (bottom/right) the chartshould be a boolean
true (when plotConfig.inverted is true)
false (when plotConfig.inverted is false)
collapsedwhether the axis should consume space in the layout (false) or not (true)should be a boolean
false
dateUTCwhether dates should be treated as UTC (true) or local (false)should be a boolean
true
displayPropertythe property to retrieve from the data provider for the group display values (use null for none)should be a defined value or equal to null
null
focusTickMarkColorthe color of the focus tick mark line(s)should be a valid svg color
focusTickMarkMarginthe margin (in pixels) to show between the inside of the axis and the focus tick mark line(s)should be a number >= to 0
3
focusTickMarkOpacitythe opacity (0 - 1) of the focus tick mark line(s)should be a number >= to 0 and <= 1
1
focusTickMarkSizethe length (in pixels) of the focus tick mark line(s)should be a number >= to 0
9
focusTickMarkWidththe stroke width (in pixels) of the focus tick mark line(s)should be a number >= to 0
3
focusTickMarkswhether to show lines perpendicular to the axis showing the focused series domain or group valueshould be a boolean
true
gridLineColorthe color of the axis grid linesshould be a valid svg color
gridLineDashArraythe dash array pattern to use when drawing the axis grid lines (use null for none)should be a valid dash array or be equal to null
"5, 5"
gridLineOpacitythe opacity (0 - 1) of the axis grid linesshould be a number >= to 0 and <= 1
1
gridLineWidththe stroke width (in pixels) of the axis grid linesshould be a number >= to 0
1
gridLineswhether to show grid lines perpendicular to each tick on the axisshould be a boolean
false
groupCountPaddingthe extra count to be added to the group value count when dividing the group extent for displaying group valuesshould be a number >= to 0
1
groupPaddingthe padding percentages (0 - 1) of the group extent for all group values (outer) and grouped series (inner)should be an object with properties [ "inner", "outer" ] all of which should be a number >= to 0 and <= 1
{ inner: 0.1 outer: 0.1}
maxthe forced maximum numeric value for the axis (use "auto" to compute from the values)

should be an iso date string or epoch number or be equal to "auto" when scale is linear and type is date

should be a number or be equal to "auto" when scale is linear and type is number

should be equal to "auto" when scale is ordinal

"auto"
maxOffsetthe numeric offset to apply to the maximum value of the axis

should be a number when scale is linear

should be equal to 0 when scale is ordinal

0
maxTickCountthe maximum number of ticks to show along the length of the axis (use 0 to disable the maximum)should be an integer and >= to 0
10 (when scale is linear)
0 (when scale is ordinal)
minthe forced minimum numeric value for the axis (use "auto" to compute from the values)

should be an iso date string or epoch number or be equal to "auto" when scale is linear and type is date

should be a number or be equal to "auto" when scale is linear and type is number

should be equal to "auto" when scale is ordinal

"auto"
minGroupValueExtentthe minimum group extent (in pixels) for a non-inverted bar this is the minimum widthshould be a number >= to 1
1
minOffsetthe numeric offset to apply to the minimum value of the axis

should be a number when scale is linear

should be equal to 0 when scale is ordinal

0
minTickIntervalthe minimum value interval to use between any two consecutive tick label valuesshould be a number >= to 0
0
minTickSpacingthe minimum space (in pixels) to allow between the the bounds of any tick label textshould be a number >= to 0
12 (when scale is linear)
4 (when scale is ordinal)
propertythe property to retrieve from the data provider for the group valuesshould be a defined value
scalethe scale to use for the displayed group values (ordinal, linear)

should be equal to "ordinal" when type is string

should be one of [ "linear", "ordinal" ]

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

should be an iso date string or epoch number or be equal to null when scale is linear and type is date

should be a number or be equal to null when scale is linear and type is number

should be equal to null when scale is ordinal

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

should be an iso date string or epoch number or be equal to null when scale is linear and type is date

should be a number or be equal to null when scale is linear and type is number

should be equal to null when scale is ordinal

null
tickCountthe number of ticks to show along the length of the axis (use "auto" to derive the tick count from the data)should be an integer and >= to 0 or be equal to "auto"
"auto"
tickLabelAnchorthe anchor to use for all axis tick labels (start, end, middle) (use "auto" to determine automatically)should be one of [ "start", "end", "middle", "auto" ]
"auto"
tickLabelFillColorthe fill color to use for the axis tick labels textshould be a valid svg color
tickLabelFillOpacitythe fill opacity (0 - 1) to use for the axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelFormatthe d3 format string to be applied to the group values when displayed in axis tick labels (use null for none, use "auto" to derive from data)

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

"auto"
tickLabelInsideMarginthe margin (in pixels) to show between the tick labels and the inside of the axisshould be a number >= to 0
6
tickLabelOutsideMarginthe margin (in pixels) to show between the tick labels and the outside of the axisshould be a number >= to 0
5
tickLabelPrefixthe string to prefix to the text of each axis tick label (use null for none)should be a string or be equal to null
null
tickLabelRotationthe rotation (in degrees) to apply to each axis tick labelshould be a number >= to -90 and <= 90
0
tickLabelSizethe space (in pixels) perpendicular to the axis direction to allocate for the tick labels (use "auto" to derive from the font size)should be a number >= to 0 or be equal to "auto"
"auto"
tickLabelStrokeColorthe stroke color to use for the axis tick labels textshould be a valid svg color
"none"
tickLabelStrokeOpacitythe stroke opacity (0 - 1) to use for the axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelStrokeWidththe stroke width (in pixels) to use for the axis tick labels textshould be a number >= to 0
0
tickLabelSuffixthe string to append to the text of each axis tick label (use null for none)should be a string or be equal to null
null
tickLabelTruncationEnabledwhether or not to use text truncation (true) when the axis tick labels would overlap each other instead of skipping ticks (false)

should be equal to false when scale is linear

should be a boolean

true (when type is string)
false (when type is not string)
tickLabelTruncationMaxPercentthe maximum percentage (0 - 1) of the chart bounds to allow any tick label text to occupy when they are perpendicular to the axisshould be a number >= to 0 and <= 1
0.2
tickLabelTruncationMinLengththe minimum length at which to apply tick label truncation if the maximum percentage settings is usedshould be a number >= to 0
0
tickLabelTruncationValuethe truncation text to append to the axis tick label text when its content is truncatedshould be a string
"…"
tickMarkColorthe color of the axis tick mark linesshould be a valid svg color
tickMarkMarginthe margin (in pixels) to show between the inside of the axis and the axis tick mark linesshould be a number >= to 0
0
tickMarkOpacitythe opacity (0 - 1) of the axis tick mark linesshould be a number >= to 0 and <= 1
1
tickMarkSizethe length (in pixels) of the axis tick mark linesshould be a number >= to 0
3
tickMarkWidththe stroke width (in pixels) of axis the tick mark linesshould be a number >= to 0
1
tickMarkswhether to show lines perpendicular to each tick value along the axisshould be a boolean
true
titlethe title text to be shown along side to the axis (use null for no title)should be a string or be equal to null
null
titleFillColorthe fill color of the axis title textshould be a valid svg color
titleFillOpacitythe fill opacity (0 - 1) of the axis title textshould be a number >= to 0 and <= 1
1
titleInsideMarginthe margin (in pixels) to show between the axis title and the inside of the axisshould be a number >= to 0
5
titleOutsideMarginthe margin (in pixels) to show between the axis title and the outside of the axisshould be a number >= to 0
5
titleSizethe space (in pixels) perpendicular to the axis direction to allocate for the axis title (use "auto" to derive from the font size)should be a number >= to 0 or be equal to "auto"
"auto"
titleStrokeColorthe stroke color of the axis title textshould be a valid svg color
"none"
titleStrokeOpacitythe stroke opacity (0 - 1) of the axis title textshould be a number >= to 0 and <= 1
1
titleStrokeWidththe stroke width (in pixels) of the axis title textshould be a number >= to 0
0
titleTruncationEnabledwhether to apply text truncation to the contents of the axis title when it would overflow the axis boundsshould be a boolean
true
titleTruncationValuethe truncation text to append to the axis title when its length exceeds the bounds of the axisshould be a string
"…"
typethe type of the displayed group values (number, date, string)should be one of [ "number", "date", "string" ]
"string"
valueFormatthe d3 format string to be applied to the group value when displayed in the tooltip (use null for none, use "auto" to derive from data)

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

"auto"
valueLabelthe label to show before a group value in the tooltip (use null for none)should be a string or be equal to null
null
valuePrefixthe text to prefix group values with when showing them in the tooltip (use null for none)should be a string or be equal to null
null
valueSuffixthe text to append group values with when showing them in the tooltip (use null for none)should be a string or be equal to null
null
visiblewhether the axis should be visibleshould be a boolean
true

Legend Config

PropertyDescriptionValidation RulesDefault
alignthe alignment for the legend (left, center, right)should be one of [ "left", "center", "right" ]
"center"
alignedToAxeswhether the legend should be centered between the axes (true) or the chart bounds (false)should be a boolean
true
backgroundStylethe styles to apply to the legend background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
filterOnClickwhether to suppress a series when the series icon or title is clickedshould be a boolean
true
focusOnClickwhether to focus a series when the series icon or title is clickedshould be a boolean
false
focusOnMouseOverwhether to focus a series when the mouse is moved over the series icon or titleshould be a boolean
true
iconBorderColorthe color of the border drawn around series iconsshould be a valid color
iconBorderSizethe width (in pixels) of the border drawn around series iconsshould be a number >= to 0
1
iconSizethe width and height (in pixels) of the series iconsshould be a number >= to 0
14
iconSpacerSizethe horizontal space (in pixels) to show between series icons and titlesshould be a number >= to 0
4
iconSuppressedColorthe color to use for the series icon when the corresponding series is suppressedshould be a valid color
iconUnsuppressedColorthe color to use for the placeholder series icons when the corresponding series is not suppressedshould be a valid color
itemBackgroundStylethe styles to apply to the legend item backgrounds (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
itemMarginthe margin (in pixels) for the top, right, bottom and left sides of the legend itemsshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 1 right: 1 bottom: 1 left: 1}
itemPaddingthe padding (in pixels) for the top, right, bottom and left sides of the legend itemsshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 1 right: 1 bottom: 1 left: 1}
marginthe margin (in pixels) for the top, right, bottom and left sides of the legendshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 5 right: 0 bottom: 0 left: 0}
paddingthe padding (in pixels) for the top, right, bottom and left sides of the legendshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 0}
positionthe position of the legend relative to the chart (top or bottom)should be one of [ "top", "bottom" ]
"bottom"
showIconColorswhether to show series colors next to series titles in the legendshould be a boolean
true
showIconPlaceholderswhether to show placeholder icons next to the series titles in the legendshould be a boolean
true
showIconShapeswhether to show series marker shape next to series titles in the legendshould be a boolean
true
truncationEnabledwhether to use text truncation when a legend item width exceeds the width of the chartshould be a boolean
true
truncationValuethe truncation text to append to legend item text when its length exceeds the length of the chartshould be a string
"…"
visiblewhether the legend should be visibleshould be a boolean
true (when seriesConfigs.length is > 1)
false (when seriesConfigs.length is <= 1)

Linear Gradient Config

PropertyDescriptionValidation RulesDefault
idthe unique identifier for the gradient so that it can be referenced for use

should be a string

should be unique

LG${index} (linear gradient index)
rotationthe rotation property (in degrees) of the svg linear gradientshould be a number >= to -360 and <= 360
0
stopsthe list of svg gradient stops, with offet, color and opacity propertiesshould be a non-empty array with elements that should be an object with exact properties { offset: should be a number >= to 0 and <= 1, color: should be a valid color, opacity: should be a number >= to 0 and <= 1 }
x1the x1 property of the svg linear gradientshould be a number >= to 0 and <= 1
0
x2the x2 property of the svg linear gradientshould be a number >= to 0 and <= 1
1
y1the x3 property of the svg linear gradientshould be a number >= to 0 and <= 1
0
y2the x4 property of the svg linear gradientshould be a number >= to 0 and <= 1
1

Plot Config

PropertyDescriptionValidation RulesDefault
backgroundStylethe styles to apply to the plot background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
invertedwhether the group axis should be left to right (false) or top to bottom (true)should be a boolean
false
marginthe margin (in pixels) for the top, right, bottom and left sides of the plotshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 0}
paddingthe padding (in pixels) for the top, right, bottom and left sides of the plotshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 0}

Radial Gradient Config

PropertyDescriptionValidation RulesDefault
cxthe cx property of the svg radial gradientshould be a number >= to 0 and <= 1
0.5
cythe cy property of the svg radial gradientshould be a number >= to 0 and <= 1
0.5
fxthe fx property of the svg radial gradientshould be a number >= to 0 and <= 1
0.5
fythe fy property of the svg radial gradientshould be a number >= to 0 and <= 1
0.5
idthe unique identifier for the gradient so that it can be referenced for use

should be a string

should be unique

RG${index} (radial gradient index)
rthe r property of the svg radial gradientshould be a number >= to 0 and <= 1
0.5
rotationthe rotation property (in degrees) of the svg radial gradientshould be a number >= to -360 and <= 360
0
stopsthe list of svg gradient stops, with offet, color and opacity propertiesshould be a non-empty array with elements that should be an object with exact properties { offset: should be a number >= to 0 and <= 1, color: should be a valid color, opacity: should be a number >= to 0 and <= 1 }

Series Axis Config

PropertyDescriptionValidation RulesDefault
adjustForSuppressionwhether to adjust the domain of the axis as series belonging to it are suppressedshould be a boolean
false
adjustTickLabelSizeForSuppressionwhether to adjust the size of the axis tick label bounds as series belonging to it are suppressedshould be a boolean
false
alwaysVisiblewhether the axis should be visible when all series belonging to it are suppressedshould be a boolean
true
axisLinewhether to show a line along the length of the axisshould be a boolean
true
axisLineColorthe color of the line shown along the axisshould be a valid svg color
axisLineDashArraythe dash array pattern to use when drawing the line shown along the axis (use null for none)should be a valid dash array or be equal to null
null
axisLineDefocusedColorthe color of the line shown along an defocused axisshould be a valid svg color
axisLineDefocusedOpacitythe opacity (0 - 1) of the line shown along an defocused axisshould be a number >= to 0 and <= 1
0.5
axisLineFocusedColorthe color of the line shown along a focused axisshould be a valid svg color
axisLineFocusedOpacitythe opacity (0 - 1) of the line shown along a focused axisshould be a number >= to 0 and <= 1
1
axisLineMarginthe margin (in pixels) between the line shown along the axis and the inner boundary of the axisshould be a number >= to 0
0
axisLineOpacitythe opacity (0 - 1) of the line shown along the axisshould be a number >= to 0 and <= 1
1
axisLineWidththe stroke width (in pixels) of the line shown along the axisshould be a number >= to 0
1
basethe numeric base value of the axis, used for animation and relative positioning for shapes (use null for none)should be a number or be equal to null
0 (series axis has stacks)
null (series axis has no stacks)
beforewhether the axis should be position before (top/left) or after (bottom/right) the chartshould be a boolean
true
collapsedwhether the axis should consume space in the layout (false) or not (true)should be a boolean
false
focusOnClickwhether the series axis should be focused whenever the user clicks/taps a part of it in the chartshould be a boolean
false
focusOnMouseOverwhether the series axis should be focused whenever the user mouses over a part of it in the chartshould be a boolean
true
focusTickMarkColorthe color of the focus tick mark line(s)should be a valid svg color
focusTickMarkMarginthe margin (in pixels) to show between the inside of the axis and the focus tick mark line(s)should be a number >= to 0
3
focusTickMarkOpacitythe opacity (0 - 1) of the focus tick mark line(s)should be a number >= to 0 and <= 1
1
focusTickMarkSizethe length (in pixels) of the focus tick mark line(s)should be a number >= to 0
9
focusTickMarkWidththe stroke width (in pixels) of the focus tick mark line(s)should be a number >= to 0
3
focusTickMarkswhether to show lines perpendicular to the axis showing the focused series domain or group valueshould be a boolean
true
gridLineColorthe color of the axis grid linesshould be a valid svg color
gridLineDashArraythe dash array pattern to use when drawing the axis grid lines (use null for none)should be a valid dash array or be equal to null
"5, 5"
gridLineDefocusedColorthe color of the defocused axis grid linesshould be a valid svg color
gridLineDefocusedOpacitythe opacity (0 - 1) of the defocused axis grid linesshould be a number >= to 0 and <= 1
0.5
gridLineFocusedColorthe color of the focused axis grid linesshould be a valid svg color
gridLineFocusedOpacitythe opacity (0 - 1) of the focused axis grid linesshould be a number >= to 0 and <= 1
1
gridLineOpacitythe opacity (0 - 1) of the axis grid linesshould be a number >= to 0 and <= 1
1
gridLineWidththe stroke width (in pixels) of the axis grid linesshould be a number >= to 0
1
gridLineswhether to show grid lines perpendicular to each tick on the axisshould be a boolean
false
idthe unique identifier for the series axis so it can be referenced by series that belong to it

should be a string

should be unique

SA${index} (series axis index)
maxthe forced maximum numeric value for the axis (use "auto" to compute from the values)should be a number or be equal to "auto"
"auto"
maxMarginPercentthe percentage margin (0 - 1) relative to the domain of the axis to use at the maximum extent of the axis (only applied if max is "auto" and max value is not equal base)should be a number >= to 0 and <= 1
0.05
maxOffsetthe numeric offset to apply to the maximum value of the axisshould be a number
0
maxTickCountthe maximum number of ticks to show along the length of the axis (use 0 to disable the maximum)should be an integer and >= to 0
10
minthe forced minimum numeric value for the axis (use "auto" to compute from the values)should be a number or be equal to "auto"
"auto"
minMarginPercentthe percentage margin (0 - 1) relative to the domain of the axis to use at the minimum extent of the axis (only applied if min is "auto" and min value is not equal base)should be a number >= to 0 and <= 1
0.05
minOffsetthe numeric offset to apply to the minimum value of the axisshould be a number
0
minTickIntervalthe minimum value interval to use between any two consecutive tick label valuesshould be a number >= to 0
0
minTickSpacingthe minimum space (in pixels) to allow between the the bounds of any tick label textshould be a number >= to 0
12
orderthe unique order number of the series axis controlling its order of appearance

should be a number

should be unique

${index} (series axis index)
scalethe scale of the series axis, must be linearshould be equal to "linear"
"linear"
softMaxthe forced maximum numeric value for the axis to be used if no data value is greater than this value (use null to disable)should be a number or be equal to null
null
softMinthe forced minimum numeric value for the axis to be used if no data value is less than this value (use null to disable)should be a number or be equal to null
null
tickCountthe number of ticks to show along the length of the axis (use "auto" to derive the tick count from the data)should be an integer and >= to 0 or be equal to "auto"
"auto"
tickLabelAnchorthe anchor to use for all axis tick labels (start, end, middle) (use "auto" to determine automatically)should be one of [ "start", "end", "middle", "auto" ]
"auto"
tickLabelDefocusedFillColorthe fill color to use for the defocused axis tick labels textshould be a valid svg color
tickLabelDefocusedFillOpacitythe fill opacity (0 - 1) to use for the defocused axis tick labels textshould be a number >= to 0 and <= 1
0.5
tickLabelDefocusedStrokeColorthe stroke color to use for the defocused axis tick labels textshould be a valid svg color
"none"
tickLabelDefocusedStrokeOpacitythe stroke opacity (0 - 1) to use for the defocused axis tick labels textshould be a number >= to 0 and <= 1
0.5
tickLabelFillColorthe fill color to use for the axis tick labels textshould be a valid svg color
tickLabelFillOpacitythe fill opacity (0 - 1) to use for the axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelFocusedFillColorthe fill color to use for the focused axis tick labels textshould be a valid svg color
tickLabelFocusedFillOpacitythe fill opacity (0 - 1) to use for the focused axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelFocusedStrokeColorthe stroke color to use for the focused axis tick labels textshould be a valid svg color
"none"
tickLabelFocusedStrokeOpacitythe stroke opacity (0 - 1) to use for the focused axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelFormatthe d3 format string to be applied to the series values when displayed in axis tick labels (use null for none, use "auto" to derive from data)should be a valid number format or be one of [ null, "auto" ]
"auto"
tickLabelInsideMarginthe margin (in pixels) to show between the tick labels and the inside of the axisshould be a number >= to 0
6
tickLabelOutsideMarginthe margin (in pixels) to show between the tick labels and the outside of the axisshould be a number >= to 0
5
tickLabelPrefixthe string to prefix to the text of each axis tick label (use null for none)should be a string or be equal to null
null
tickLabelRotationthe rotation (in degrees) to apply to each axis tick labelshould be a number >= to -90 and <= 90
0
tickLabelSizethe space (in pixels) perpendicular to the axis direction to allocate for the tick labels (use "auto" to derive from the font size)should be a number >= to 0 or be equal to "auto"
"auto"
tickLabelStrokeColorthe stroke color to use for the axis tick labels textshould be a valid svg color
"none"
tickLabelStrokeOpacitythe stroke opacity (0 - 1) to use for the axis tick labels textshould be a number >= to 0 and <= 1
1
tickLabelStrokeWidththe stroke width (in pixels) to use for the axis tick labels textshould be a number >= to 0
0
tickLabelSuffixthe string to append to the text of each axis tick label (use null for none)should be a string or be equal to null
null
tickMarkColorthe color of the axis tick mark linesshould be a valid svg color
tickMarkDefocusedColorthe color of the defocused axis tick mark linesshould be a valid svg color
tickMarkDefocusedOpacitythe opacity (0 - 1) of the defocused axis tick mark linesshould be a number >= to 0 and <= 1
0.5
tickMarkFocusedColorthe color of the focused axis tick mark linesshould be a valid svg color
tickMarkFocusedOpacitythe opacity (0 - 1) of the focused axis tick mark linesshould be a number >= to 0 and <= 1
1
tickMarkMarginthe margin (in pixels) to show between the inside of the axis and the axis tick mark linesshould be a number >= to 0
0
tickMarkOpacitythe opacity (0 - 1) of the axis tick mark linesshould be a number >= to 0 and <= 1
1
tickMarkSizethe length (in pixels) of the axis tick mark linesshould be a number >= to 0
3
tickMarkWidththe stroke width (in pixels) of axis the tick mark linesshould be a number >= to 0
1
tickMarkswhether to show lines perpendicular to each tick value along the axisshould be a boolean
true
titlethe title text to be shown along side to the axis (use null for no title)should be a string or be equal to null
null
titleDefocusedFillColorthe fill color of the defocused axis title textshould be a valid svg color
titleDefocusedFillOpacitythe fill opacity (0 - 1) of the defocused axis title textshould be a number >= to 0 and <= 1
0.5
titleDefocusedStrokeColorthe stroke color of the defocused axis title textshould be a valid svg color
"none"
titleDefocusedStrokeOpacitythe stroke opacity (0 - 1) of the defocused axis title textshould be a number >= to 0 and <= 1
0.5
titleFillColorthe fill color of the axis title textshould be a valid svg color
titleFillOpacitythe fill opacity (0 - 1) of the axis title textshould be a number >= to 0 and <= 1
1
titleFocusedFillColorthe fill color of the focused axis title textshould be a valid svg color
titleFocusedFillOpacitythe fill opacity (0 - 1) of the focused axis title textshould be a number >= to 0 and <= 1
1
titleFocusedStrokeColorthe stroke color of the focused axis title textshould be a valid svg color
"none"
titleFocusedStrokeOpacitythe stroke opacity (0 - 1) of the focused axis title textshould be a number >= to 0 and <= 1
1
titleInsideMarginthe margin (in pixels) to show between the axis title and the inside of the axisshould be a number >= to 0
5
titleOutsideMarginthe margin (in pixels) to show between the axis title and the outside of the axisshould be a number >= to 0
5
titleSizethe space (in pixels) perpendicular to the axis direction to allocate for the axis title (use "auto" to derive from the font size)should be a number >= to 0 or be equal to "auto"
"auto"
titleStrokeColorthe stroke color of the axis title textshould be a valid svg color
"none"
titleStrokeOpacitythe stroke opacity (0 - 1) of the axis title textshould be a number >= to 0 and <= 1
1
titleStrokeWidththe stroke width (in pixels) of the axis title textshould be a number >= to 0
0
titleTruncationEnabledwhether to apply text truncation to the contents of the axis title when it would overflow the axis boundsshould be a boolean
true
titleTruncationValuethe truncation text to append to the axis title when its length exceeds the bounds of the axisshould be a string
"…"
typethe type of the series axis, must be numbershould be equal to "number"
"number"
useSeriesFocuswhether to show the axis as focused when any series belonging to is focusedshould be a boolean
true
visiblewhether the axis should be visibleshould be a boolean
true

Series Config

PropertyDescriptionValidation RulesDefault
animateBaseFromAdjacentwhether to animate leading/trailing series position values from their adjacent values (true) or from the base value (false)should be a boolean
false (when renderer is bar)
true (when renderer is line)
true (when renderer is area)
false (when renderer is none)
axisthe unique identifier of the axis that the series belongs to

should be a string

should equal the id property of one of the seriesAxisConfigs

sole axis id (series axis)
capExpandwhether to expand the base of caps on a bar series when the size of the cap is greater than the extent of the barshould be a boolean
true
capOnlyStackOuterwhether to only show the cap on bars in the series when they are an outer series of a stackshould be a boolean
false
capSizethe size of the cap (in pixels) to use when drawing caps on a bar seriesshould be a number >= to 0
5
capTypethe type (point, curve, round, use null for none) of cap to use when drawing caps on a bar seriesshould be one of [ "point", "curve", "round" ] or be equal to null
null
colorBasethe base value to use for color interpolation, allowing 2 distinct sets of min & max colors for interpolation (use null for none)should be a number or be equal to null
null
colorBaseAboveMaxthe maximum color to use when interpolating the series shape color with a colorProperty value that is above the colorBase (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is null

should be a valid color when colorProperty is not null and colorBase is not null

null (when colorProperty is null)
null (when colorProperty is not null and colorBase is null)
(when colorProperty is not null and colorBase is not null)
colorBaseAboveMinthe minimum color to use when interpolating the series shape color with a colorProperty value that is above the colorBase (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is null

should be a valid color when colorProperty is not null and colorBase is not null

null (when colorProperty is null)
null (when colorProperty is not null and colorBase is null)
(when colorProperty is not null and colorBase is not null)
colorBaseBelowMaxthe maximum color to use when interpolating the series shape color with a colorProperty value that is below the colorBase (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is null

should be a valid color when colorProperty is not null and colorBase is not null

null (when colorProperty is null)
null (when colorProperty is not null and colorBase is null)
(when colorProperty is not null and colorBase is not null)
colorBaseBelowMinthe minimum color to use when interpolating the series shape color with a colorProperty value that is below the colorBase (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is null

should be a valid color when colorProperty is not null and colorBase is not null

null (when colorProperty is null)
null (when colorProperty is not null and colorBase is null)
(when colorProperty is not null and colorBase is not null)
colorInterpolationthe type of d3 color interpolation to apply when using a color property (rgb, hsl, lab, hcl) (use null for none)

should be one of [ "rgb", "hsl", "lab", "hcl" ] when colorProperty is not null

should be equal to null when colorProperty is null

null (when colorProperty is null)
"hcl" (when colorProperty is not null)
colorMaxthe maximum color to use when interpolating the series shape color with a colorProperty (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is not null

should be a valid color when colorProperty is not null and colorBase is null

null (when colorProperty is null)
(when colorProperty is not null and colorBase is null)
null (when colorProperty is not null and colorBase is not null)
colorMinthe minimum color to use when interpolating the series shape color with a colorProperty (use null for none)

should be equal to null when colorProperty is null

should be equal to null when colorProperty is not null and colorBase is not null

should be a valid color when colorProperty is not null and colorBase is null

null (when colorProperty is null)
(when colorProperty is not null and colorBase is null)
null (when colorProperty is not null and colorBase is not null)
colorPropertythe property to retrieve from the data provider for the series color values (use null for none)should be a defined value or equal to null
null
curvethe d3 curve type and param to use when drawing the series shapeshould be an object with exact properties { type: should be one of [ "linear", "monotoneX", "monotoneY", "basis", "cardinal", "catmullRom", "natural", "step", "stepBefore", "stepAfter" ], param: should be a number >= to 0 and <= 1 or be equal to undefined }
{ type: "linear"}
defocusedFillColorthe defocused fill color to use for the series shape (use "same" to reuse the fillColor, use "seriesIndex" to apply the colorPaletteConfig seriesDefocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig seriesDefocused fillColor for the group index)should be a valid svg color or be one of [ "same", "seriesIndex", "groupIndex" ]
"same"
defocusedFillOpacitythe defocused fill opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
0.5 (when renderer is bar)
0.8 (when renderer is line)
0.5 (when renderer is area)
0.8 (when renderer is none)
defocusedStrokeColorthe defocused stroke color to use for the series shape (use "same" to reuse the strokeColor, use "seriesIndex" to apply the colorPaletteConfig seriesDefocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig seriesDefocused strokeColor for the group index)should be a valid svg color or be one of [ "same", "seriesIndex", "groupIndex" ]
"same"
defocusedStrokeOpacitythe defocused stroke opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
0.5 (when renderer is bar)
0.8 (when renderer is line)
0.5 (when renderer is area)
0.8 (when renderer is none)
defocusedStrokeWidththe defocused stroke width (in pixels) of the series shapeshould be a number >= to 0
0 (when renderer is bar)
2 (when renderer is line)
0 (when renderer is area)
0 (when renderer is none)
fillColorthe fill color to use for the series shape (use "seriesIndex" to apply the colorPaletteConfig series fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig series fillColor for the group index)should be a valid svg color or be one of [ "seriesIndex", "groupIndex" ]
"seriesIndex"
fillOpacitythe fill opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
0.8 (when renderer is bar)
0.9 (when renderer is line)
0.8 (when renderer is area)
0.9 (when renderer is none)
focusGroupOnClickwhether the group should be focused whenever the user clicks/taps a group of the series in the chartshould be a boolean
false
focusGroupOnMouseOverwhether the group should be focused whenever the user mouses over a group of the series in the chartshould be a boolean
false
focusOnClickwhether the series should be focused whenever the user clicks/taps a part of it in the chartshould be a boolean
false
focusOnMouseOverwhether the series should be focused whenever the user mouses over a part of it in the chartshould be a boolean
false
focusedFillColorthe focused fill color to use for the series shape (use "same" to reuse the fillColor, use "seriesIndex" to apply the colorPaletteConfig seriesFocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig seriesFocused fillColor for the group index)should be a valid svg color or be one of [ "same", "seriesIndex", "groupIndex" ]
"same"
focusedFillOpacitythe focused fill opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
1 (when renderer is bar)
1 (when renderer is line)
1 (when renderer is area)
1 (when renderer is none)
focusedStrokeColorthe focused stroke color to use for the series shape (use "same" to reuse the strokeColor, use "seriesIndex" to apply the colorPaletteConfig seriesFocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig seriesFocused strokeColor for the group index)should be a valid svg color or be one of [ "same", "seriesIndex", "groupIndex" ]
"same"
focusedStrokeOpacitythe focused stroke opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
1 (when renderer is bar)
1 (when renderer is line)
1 (when renderer is area)
1 (when renderer is none)
focusedStrokeWidththe focused stroke width (in pixels) of the series shapeshould be a number >= to 0
1 (when renderer is bar)
4 (when renderer is line)
1 (when renderer is area)
0 (when renderer is none)
gradientthe unique id of the gradient config to be used when coloring the series shape (use null for none)

should be a string or be equal to null

should equal the id property of one of the linearGradientConfigs or radialGradientConfigs

sole gradient id (series gradient)
groupthe unique identifier of the series group that the series belongs to (use null for none)

should be a string or be equal to null

should equal the id property of one of the seriesGroupConfigs

sole group id (series group)
idthe unique identifier for the series

should be a string

should be unique

S${index} (series index)
ignorewhether to ignore this series and treat it as though it were not specifiedshould be a boolean
false
labelAboveBaseMaxPositionPercentthe maximum position percentage (0 - 1) from the domain maximum for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]
"auto"
labelAboveBaseMinPositionPercentthe minimum position percentage (0 - 1) above the base value for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]
"auto"
labelAboveBaseOffsetthe series position offset (in pixels) to apply to all series label positions that are above the base value (use "auto" to derive from the labelOffset)should be a number or be equal to "auto"
"auto"
labelAboveBasePositionwhether to position the series labels inside or outside of the series shape for series shapes that are above the base valueshould be one of [ "auto", "inside", "center", "outside" ]
"auto"
labelBelowBaseMaxPositionPercentthe maximum position percentage (0 - 1) below the base value for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]
"auto"
labelBelowBaseMinPositionPercentthe minimum position percentage (0 - 1) from the domain minimum for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be one of [ null, "auto" ]
"auto"
labelBelowBaseOffsetthe series position offset (in pixels) to apply to all series label positions that are below the base value (use "auto" to derive from the labelOffset)should be a number or be equal to "auto"
"auto"
labelBelowBasePositionwhether to position the series labels inside or outside of the series shape for series shapes that are below the base valueshould be one of [ "auto", "inside", "center", "outside" ]
"auto"
labelDefocusedFillColorthe defocused fill color to use for the series label values (use "series" to reuse the defocusedFillColor, use "same" to reuse the labelFillColor, use "seriesIndex" to apply the colorPaletteConfig labelDefocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig labelDefocused fillColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
labelDefocusedFillOpacitythe defocused fill opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
1
labelDefocusedStrokeColorthe defocused stroke color to use for the series label values (use "series" to reuse the defocusedStrokeColor, use "same" to reuse the labelStrokeColor, use "seriesIndex" to apply the colorPaletteConfig labelDefocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig labelDefocused strokeColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
labelDefocusedStrokeOpacitythe defocused stroke opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
1
labelDefocusedStrokeWidththe defocused stroke width (in pixels) for the series label textshould be a number >= to 0
1
labelFillColorthe fill color to use for the series label values (use "series" to reuse the fillColor, use "seriesIndex" to apply the colorPaletteConfig label fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig label fillColor for the group index)should be a valid svg color or be one of [ "series", "seriesIndex", "groupIndex" ]
labelFillOpacitythe fill opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
0.8
labelFocusedFillColorthe focused fill color to use for the series label values (use "series" to reuse the focusedFillColor, use "same" to reuse the labelFillColor, use "seriesIndex" to apply the colorPaletteConfig labelFocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig labelFocused fillColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
labelFocusedFillOpacitythe focused fill opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
1
labelFocusedStrokeColorthe focused stroke color to use for the series label values (use "series" to reuse the focusedStrokeColor, use "same" to reuse the labelStrokeColor, use "seriesIndex" to apply the colorPaletteConfig labelFocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig labelFocused strokeColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
labelFocusedStrokeOpacitythe focused stroke opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
1
labelFocusedStrokeWidththe focused stroke width (in pixels) for the series label textshould be a number >= to 0
1
labelFormatthe d3 format string to be applied to the series label values (use null for none, use "auto" to derive from data)should be a valid number format or be one of [ null, "auto" ]
"auto"
labelMaxPositionPercentthe maximum position percentage (0 - 1) from the domain maximum for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be equal to null
null
labelMinPositionPercentthe minimum position percentage (0 - 1) from the domain minimum for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be equal to null
null
labelMinRangePercentthe minimum position percentage (0 - 1) between two series values for which series labels should be shown (use null for none)should be a number >= to 0 and <= 1 or be equal to null
null
labelOffsetthe series position offset (in pixels) to apply to all series label positionsshould be a number
0
labelPositionwhether to position the series labels inside or outside of the series shapeshould be one of [ "inside", "center", "outside" ]
"center"
labelPropertythe property to retrieve from the data provider for the series label values (use null for none)should be a defined value or equal to null
null
labelStrokeColorthe stroke color to use for the series label values (use "series" to reuse the strokeColor, use "seriesIndex" to apply the colorPaletteConfig label strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig label strokeColor for the group index)should be a valid svg color or be one of [ "series", "seriesIndex", "groupIndex" ]
labelStrokeOpacitythe stroke opacity (0 - 1) for the series label textshould be a number >= to 0 and <= 1
0.8
labelStrokeWidththe stroke width (in pixels) for the series label textshould be a number >= to 0
1
markerDefocusedFillColorthe defocused fill color to use for the series marker (use "series" to reuse the defocusedFillColor, use "same" to reuse the markerFillColor, use "seriesIndex" to apply the colorPaletteConfig markerDefocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig markerDefocused fillColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
markerDefocusedFillOpacitythe defocused fill opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
0.8
markerDefocusedStrokeColorthe defocused stroke color to use for the series marker (use "series" to reuse the defocusedStrokeColor, use "same" to reuse the markerStrokeColor, use "seriesIndex" to apply the colorPaletteConfig markerDefocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig markerDefocused strokeColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
markerDefocusedStrokeOpacitythe defocused stroke opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
0.8
markerDefocusedStrokeWidththe defocused stroke width (in pixels) for the series marker shapeshould be a number >= to 0
1
markerFillColorthe fill color to use for the series marker (use "series" to reuse the fillColor, use "seriesIndex" to apply the colorPaletteConfig marker fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig marker fillColor for the group index)should be a valid svg color or be one of [ "series", "seriesIndex", "groupIndex" ]
"series"
markerFillOpacitythe fill opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
0.9
markerFocusedFillColorthe focused fill color to use for the series marker (use "series" to reuse the focusedFillColor, use "same" to reuse the markerFillColor, use "seriesIndex" to apply the colorPaletteConfig markerFocused fillColor for the series index, use "groupIndex" to apply the colorPaletteConfig markerFocused fillColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
markerFocusedFillOpacitythe focused fill opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
1
markerFocusedStrokeColorthe focused stroke color to use for the series marker (use "series" to reuse the focusedStrokeColor, use "same" to reuse the markerStrokeColor, use "seriesIndex" to apply the colorPaletteConfig markerFocused strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig markerFocused strokeColor for the group index)should be a valid svg color or be one of [ "series", "same", "seriesIndex", "groupIndex" ]
"same"
markerFocusedStrokeOpacitythe focused stroke opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
1
markerFocusedStrokeWidththe focused stroke width (in pixels) for the series marker shapeshould be a number >= to 0
3
markerPropertythe property to retrieve from the data provider for the marker size values (use null for none)should be a defined value or equal to null
null
markerShapethe shape to use when drawing the series marker (circle, cross, diamond, square, star, triangle, wye) (use null for none)should be one of [ null, "circle", "cross", "diamond", "square", "star", "triangle", "wye" ]
null (when renderer is bar)
"circle" (when renderer is line)
"circle" (when renderer is area)
"circle" (when renderer is none)
markerShowMissingwhether to show the marker when the value is missing (can be used in conjunction with showMissingAtBase)should be a boolean
false
markerSizethe maximum marker size (in pixels) to use when interpolating the marker size based on a marker property value, or the marker size when no marker property is usedshould be a number >= to 0
6
markerStrokeColorthe stroke color to use for the series marker (use "series" to reuse the strokeColor, use "seriesIndex" to apply the colorPaletteConfig marker strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig marker strokeColor for the group index)should be a valid svg color or be one of [ "series", "seriesIndex", "groupIndex" ]
"series"
markerStrokeOpacitythe stroke opacity (0 -1) for the series marker shapeshould be a number >= to 0 and <= 1
0.9
markerStrokeWidththe stroke width (in pixels) for the series marker shapeshould be a number >= to 0
1
minMarkerSizethe minimum marker size (in pixels) to use when interpolating the marker size based on a marker property valueshould be a number >= to 0
1
orderthe unique order number of the series controlling its order of appearance

should be a number

should be unique

${index} (series index)
propertythe property to retrieve from the data provider for the series valuesshould be a defined value
rangePropertythe property to retrieve from the data provider for the secondary series values (use null for none)should be a defined value or equal to null
null
rendererthe shape renderer to use when drawing the series shape (line, area, bar, none)should be one of [ "bar", "line", "area", "none" ]
"line"
showColorInLegendwhether to show the series color as an icon next to the series title in the legendshould be a boolean
false (when color is groupIndex)
true (when color is not groupIndex)
showColorInTooltipwhether to show the series color as an icon next to the series title in the tooltipshould be a boolean
false (when color is groupIndex)
true (when color is not groupIndex)
showInLegendwhether to show the series in the legendshould be a boolean
true
showInTooltipwhether to show the series in the tooltipshould be a boolean
true
showMissingAtBasewhether to use the series axis base value for missing values when drawing the shape for this seriesshould be a boolean
false
skipMissingwhether to skip undefined values when drawing the shape for this seriesshould be a boolean
false
stackthe unique identifier of the series stack that the series belongs to (use null for none)

should be a string or be equal to null

should equal the id property of one of the seriesStackConfigs

should equal the id property of one of the seriesStackConfigs that has the same axis property

sole stack id (series stack)
strokeColorthe stroke color to use for the series shape (use "seriesIndex" to apply the colorPaletteConfig series strokeColor for the series index, use "groupIndex" to apply the colorPaletteConfig series strokeColor for the group index)should be a valid svg color or be one of [ "seriesIndex", "groupIndex" ]
"seriesIndex"
strokeOpacitythe stroke opacity (0 - 1) of the series shapeshould be a number >= to 0 and <= 1
0.8 (when renderer is bar)
0.9 (when renderer is line)
0.8 (when renderer is area)
0.9 (when renderer is none)
strokeWidththe stroke width (in pixels) of the series shapeshould be a number >= to 0
0 (when renderer is bar)
3 (when renderer is line)
0 (when renderer is area)
0 (when renderer is none)
suppressiblewhether or not the series can be suppressed from being shown in the chartshould be a boolean
true
titlethe title to display for the series in the legend (use null for none)should be a string or be equal to null
null
useAxisFocuswhether to show the series as focused when the series axis it belongs to is focusedshould be a boolean
true
useTitleForValueLabelwhether to use the title value for the valueLabel value when the valueLabel is not setshould be a boolean
true
valueFormatthe d3 format string to be applied to the series value when displayed in the tooltip (use null for none, use "auto" to derive from data ("auto" will use the series axis tick label format if it is set))should be a valid number format or be one of [ null, "auto" ]
"auto"
valueLabelthe label to show before a series value in the tooltip (use null for none)should be a string or be equal to null
null
valuePrefixthe text to prefix series values with when showing them in the tooltip (use null for none)should be a string or be equal to null
null
valueSuffixthe text to append series values with when showing them in the tooltip (use null for none)should be a string or be equal to null
null

Series Group Config

PropertyDescriptionValidation RulesDefault
idthe unique identifier for the series group so it can be referenced by series that belong to it

should be a string

should be unique

SG${index} (series group index)

Series Stack Config

PropertyDescriptionValidation RulesDefault
axisthe unqiue identifier of the series axis that the series stack belongs to

should be a string

should equal the id property of one of the seriesAxisConfigs

first axis id (series axis)
idthe unique identifier for the series stack so it can be referenced by series that belong to it

should be a string

should be unique

SS${index} (series stack index)
outerCapExpandwhether to expand the base of caps for series that are an outer series of the stack when the size of the cap is greater than the extent of the barshould be a boolean
true
outerCapSizethe size of the cap (in pixels) for series that are an outer series of the stackshould be a number >= to 0
5
outerCapTypethe type (point, curve, round, use null for none) of cap for series that are an outer series of the stackshould be one of [ "point", "curve", "round" ] or be equal to null
null

Title Config

PropertyDescriptionValidation RulesDefault
alignthe alignment for the title (left, center, right)should be one of [ "left", "center", "right" ]
"center"
alignedToAxeswhether the title should be aligned between the axes (true) or the chart bounds (false)should be a boolean
true
backgroundStylethe styles to apply to the title background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
linkDisabledwhether to prevent default navigation behaviour when the link is clickedshould be a boolean
false
marginthe margin (in pixels) for the top, right, bottom and left sides of the titleshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 5 left: 0}
paddingthe padding (in pixels) for the top, right, bottom and left sides of the titleshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 5 left: 0}
positionthe position of the title relative to the chart (top or bottom)should be one of [ "top", "bottom" ]
"top"
prefixBackgroundStylethe styles to apply to the title prefix background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
prefixMarginthe margin (in pixels) for the top, right, bottom and left sides of the title prefixshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 5 bottom: 0 left: 0}
prefixPaddingthe padding (in pixels) for the top, right, bottom and left sides of the title prefixshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 5 bottom: 0 left: 0}
prefixTextStylethe styles to apply to the title prefix text (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: null strokeWidth: null fill: null fillOpacity: null}
suffixBackgroundStylethe styles to apply to the title suffix background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
suffixMarginthe margin (in pixels) for the top, right, bottom and left sides of the title suffixshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 5}
suffixPaddingthe padding (in pixels) for the top, right, bottom and left sides of the title suffixshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 5}
suffixTextStylethe styles to apply to the title suffix text (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: null strokeWidth: null fill: null fillOpacity: null}
textMarginthe margin (in pixels) for the top, right, bottom and left sides of the title textshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 0}
textPaddingthe padding (in pixels) for the top, right, bottom and left sides of the title textshould be an object with properties [ "top", "right", "bottom", "left" ] all of which should be a number >= to 0
{ top: 0 right: 0 bottom: 0 left: 0}
titlethe text to display in the title at the top of the chart (use null for none)should be a string or be equal to null
null
titleBackgroundStylethe styles to apply to the title text background (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: 0 strokeWidth: null fill: null fillOpacity: 0}
titlePrefixthe text to display at the start of the title at the top of the chart (use null for none)should be a string or be equal to null
null
titleSuffixthe text to display at the end of the title at the top of the chart (use null for none)should be a string or be equal to null
null
titleTextStylethe styles to apply to the title text (stroke, strokeOpacity, strokeWidth, fill, fillOpacity (use null for none))should be an object with exact properties { stroke: should be a valid svg color or be equal to null, strokeOpacity: should be a number >= to 0 and <= 1 or be equal to null, fill: should be a valid svg color or be equal to null, fillOpacity: should be a number >= to 0 and <= 1 or be equal to null, strokeWidth: should be a number >= to 0 or be equal to null }
{ stroke: null strokeOpacity: null strokeWidth: null fill: null fillOpacity: null}
truncationEnabledwhether to use text truncation when the title width exceeds the width of the chartshould be a boolean
true
truncationValuethe truncation text to append to the title when its length exceeds the length of the chartshould be a string
"…"
verticalAlignthe vertical alignment of the prefix/text/suffix within the titleshould be one of [ "top", "middle", "bottom" ]
"middle"
verticalExpandwhether to expand the padding height of the prefix/text/suffix to match the max section heightshould be a boolean
false

Tooltip Config

PropertyDescriptionValidation RulesDefault
adjustForSuppressionwhether to adjust the series values when series suppression changesshould be a boolean
true
adjustSizeForSuppressionwhether to adjust the width of the tooltip when the series values change due to suppression changesshould be a boolean
false
alignValueswhether to right-align the values shown in the tooltipshould be a boolean
true
applyFocuswhether to change the focused group as the tooltip is shown or hiddenshould be a boolean
true
backgroundColorthe background color for the interior of the tooltipshould be a valid color
borderColorthe color of the border around the tooltipshould be a valid color
borderRadiusthe radius (in pixels) of the corners of the tooltipshould be a number >= to 0
4
borderWidththe width (in pixels) of the the border around the tooltipshould be a number >= to 0
2
closeOnClickwhether to hide the tooltip when the user clicks/taps within itshould be a boolean
true
dropShadowBlurRadiusthe blur radius (in pixels) of the drop shadow effect used for the tooltipshould be a number >= to 0
10
dropShadowColorthe color of the drop shadow effect used for the tooltipshould be a valid color
dropShadowOffsetXthe x offset (in pixels) of the drop shadow effect used for the tooltipshould be a number >= to 0
0
dropShadowOffsetYthe y offset (in pixels) of the drop shadow effect used for the tooltipshould be a number >= to 0
5
filterOnSeriesClickwhether series should be filtered when the user clicks/taps on them in the tooltipshould be a boolean
false
focusOnGroupClickwhether group values should be focused when the user clicks/taps on them in the tooltipshould be a boolean
false
focusOnGroupMouseOverwhether group values should be focused when the user mouses over them in the tooltipshould be a boolean
false
focusOnSeriesClickwhether series should be focused when the user clicks/taps on them in the tooltipshould be a boolean
false
focusOnSeriesMouseOverwhether series should be focused when the user mouses over them in the tooltipshould be a boolean
false
hideSuppressedwhether to hide series that have been suppressed from the tooltipshould be a boolean
false
iconBorderColorthe color of the border drawn around series iconsshould be a valid color
iconBorderSizethe width (in pixels) of the border drawn around series iconsshould be a number >= to 0
1
iconSizethe width and height (in pixels) of the series iconsshould be a number >= to 0
14
iconSpacerSizethe horizontal space (in pixels) to show between series icons and titlesshould be a number >= to 0
4
iconSuppressedColorthe color to use for the series icon when the corresponding series is suppressedshould be a valid color
iconUnsuppressedColorthe color to use for the placeholder series icons when the corresponding series is not suppressedshould be a valid color
keepInsidewhether to keep the tooltip within the series drawing area (true) or allow it to overlap the axes (false)should be a boolean
false
linePaddingthe padding (in pixels) betwen each line of the tooltipshould be a number >= to 0
3
minWidththe minimum width (in pixels) for the tooltipshould be a number >= to 0
120
missingValueTextthe text to show for series that do not have defined valuesshould be a string
"N/A"
mouseOverwhether the tooltip should be track the mouse position in the chart drawing areashould be a boolean
false
paddingthe padding (in pixels) to show on each side of the tooltipshould be a number >= to 0
2
rangeValueTextthe text to use when joining the values for a series that has more than one valueshould be a string
" - "
showControlswhether the focus/filter controls should be shown at the top of the tooltipshould be a boolean
false
showIconColorswhether to show series colors next to series titles in the tooltipshould be a boolean
true
showIconPlaceholderswhether to show placeholder icons next to the series titles in the tooltipshould be a boolean
true
showIconShapeswhether to show series marker shape next to series titles in the tooltipshould be a boolean
true
showMissingValueswhether to show series that do not have defined values in the tooltipshould be a boolean
true
snapToGroupwhether the tooltip should be centered at the closest group value (true) or at the click/tap position (false)should be a boolean
true
suppressedValueCharacterthe character to show in place of each digit of a series value that has been suppressed (use null for none)should be a string with length 1 or be equal to null
"-"
suppressedValueTextthe text to show for series that have been suppressed (use null for none)should be a string or be equal to null
null
visiblewhether or not to show the tooltipshould be a boolean
true