| Property | Description | Validation Rules | Default | Details |
|---|---|---|---|---|
| animationConfig | Configure the chart animation settings | should be an object | {} | Details |
| chartConfig | Configure general settings of the chart | should be an object | {} | Details |
| colorPaletteConfig | Configure the color palettes to use for collections of series | should be an object | {} | Details |
| crosshairConfig | Configure the crosshair styling and behavior when a group and/or series is focused | should be an object | {} | Details |
| groupAxisConfig | Configure the chart group axis content and styling | should be an object | {} | Details |
| legendConfig | Configure the chart legend which itemizes the series | should 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 |
| plotConfig | Configure the chart plot content and styling | should 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 |
| titleConfig | Configure the chart title | should be an object | {} | Details |
| tooltipConfig | Configure the chart tooltip styling and behavior | should be an object | {} | Details |
| version | The version of the configuration format | should be equal to "1.0.3" |
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| animate | whether all animation should be enabled or disabled | should be a boolean | true
|
| collapseDuration | the maximum duration for the axis collapse animation phase when new data is removed from the chart | should be a number >= to 0 | 1000
|
| expansionDuration | the maximum duration for the axis expansion animation phase when new data is added to the chart | should be a number >= to 0 | 1000
|
| focusDuration | the duration of animation showing the transition between focus on a specific series or group value | should be a number >= to 0 | 1000
|
| initialDuration | the maximum duration for the initial animation when chart data is first loaded | should be a number >= to 0 | 1000
|
| valueChangeDuration | the maximum duration for the value change animation phase when data in the chart changes | should be a number >= to 0 | 1000
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| backgroundStyle | the 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}
|
| margin | the margin (in pixels) for the top, right, bottom and left sides of the chart | should 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}
|
| padding | the padding (in pixels) for the top, right, bottom and left sides of the chart | should 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}
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| label | the color palette to use for series labels that are colored by series or group index | should 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: }
|
| labelDefocused | the color palette to use for defocused series labels that are colored by series or group index | should 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: }
|
| labelFocused | the color palette to use for focused series labels that are colored by series or group index | should 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: }
|
| marker | the color palette to use for series markers that are colored by series or group index | should 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: }
|
| markerDefocused | the color palette to use for defocused series markers that are colored by series or group index | should 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: }
|
| markerFocused | the color palette to use for focused series markers that are colored by series or group index | should 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: }
|
| series | the color palette to use for series shapes that are colored by series or group index | should 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: }
|
| seriesDefocused | the color palette to use for defocused series shapes that are colored by series or group index | should 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: }
|
| seriesFocused | the color palette to use for focused series shapes that are colored by series or group index | should 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: }
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| applyFocus | whether to change the focused group as the crosshairs are shown or hidden | should be a boolean | true
|
| lineColor | the color to use when showing the crosshair lines | should be a valid svg color | |
| lineDashArray | the 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"
|
| lineWidth | the stroke width (in pixels) of the crosshair lines | should be a number >= to 0 | 3
|
| showBehindTooltip | whether to show the crosshair lines for sections where they are overlapped by the tooltip | should be a boolean | false
|
| showGroup | whether or not crosshair lines for focused groups should be shown | should be a boolean | true
|
| showSeries | whether or not crosshair lines for focused series should be shown | should be a boolean | true
|
| visible | whether or not crosshairs should be shown when a group or series is focused | should be a boolean | true
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| axisLine | whether to show a line along the length of the axis | should be a boolean | true
|
| axisLineColor | the color of the line shown along the axis | should be a valid svg color | |
| axisLineDashArray | the 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
|
| axisLineMargin | the margin (in pixels) between the line shown along the axis and the inner boundary of the axis | should be a number >= to 0 | 0
|
| axisLineOpacity | the opacity (0 - 1) of the line shown along the axis | should be a number >= to 0 and <= 1 | 1
|
| axisLineWidth | the stroke width (in pixels) of the line shown along the axis | should be a number >= to 0 | 1
|
| before | whether the axis should be position before (top/left) or after (bottom/right) the chart | should be a boolean | true (when plotConfig.inverted is true)
false (when plotConfig.inverted is false)
|
| collapsed | whether the axis should consume space in the layout (false) or not (true) | should be a boolean | false
|
| dateUTC | whether dates should be treated as UTC (true) or local (false) | should be a boolean | true
|
| displayProperty | the 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
|
| focusTickMarkColor | the color of the focus tick mark line(s) | should be a valid svg color | |
| focusTickMarkMargin | the 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
|
| focusTickMarkOpacity | the opacity (0 - 1) of the focus tick mark line(s) | should be a number >= to 0 and <= 1 | 1
|
| focusTickMarkSize | the length (in pixels) of the focus tick mark line(s) | should be a number >= to 0 | 9
|
| focusTickMarkWidth | the stroke width (in pixels) of the focus tick mark line(s) | should be a number >= to 0 | 3
|
| focusTickMarks | whether to show lines perpendicular to the axis showing the focused series domain or group value | should be a boolean | true
|
| gridLineColor | the color of the axis grid lines | should be a valid svg color | |
| gridLineDashArray | the 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"
|
| gridLineOpacity | the opacity (0 - 1) of the axis grid lines | should be a number >= to 0 and <= 1 | 1
|
| gridLineWidth | the stroke width (in pixels) of the axis grid lines | should be a number >= to 0 | 1
|
| gridLines | whether to show grid lines perpendicular to each tick on the axis | should be a boolean | false
|
| groupCountPadding | the extra count to be added to the group value count when dividing the group extent for displaying group values | should be a number >= to 0 | 1
|
| groupPadding | the 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}
|
| max | the 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"
|
| maxOffset | the 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
|
| maxTickCount | the 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)
|
| min | the 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"
|
| minGroupValueExtent | the minimum group extent (in pixels) for a non-inverted bar this is the minimum width | should be a number >= to 1 | 1
|
| minOffset | the 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
|
| minTickInterval | the minimum value interval to use between any two consecutive tick label values | should be a number >= to 0 | 0
|
| minTickSpacing | the minimum space (in pixels) to allow between the the bounds of any tick label text | should be a number >= to 0 | 12 (when scale is linear)
4 (when scale is ordinal)
|
| property | the property to retrieve from the data provider for the group values | should be a defined value | |
| scale | the 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"
|
| softMax | the forced maximum numeric value for the axis to be used if no data value is greater than this value (use null to disable) | 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
|
| softMin | the forced minimum numeric value for the axis to be used if no data value is less than this value (use null to disable) | 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
|
| tickCount | the 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"
|
| tickLabelAnchor | the 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"
|
| tickLabelFillColor | the fill color to use for the axis tick labels text | should be a valid svg color | |
| tickLabelFillOpacity | the fill opacity (0 - 1) to use for the axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelFormat | the 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"
|
| tickLabelInsideMargin | the margin (in pixels) to show between the tick labels and the inside of the axis | should be a number >= to 0 | 6
|
| tickLabelOutsideMargin | the margin (in pixels) to show between the tick labels and the outside of the axis | should be a number >= to 0 | 5
|
| tickLabelPrefix | the 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
|
| tickLabelRotation | the rotation (in degrees) to apply to each axis tick label | should be a number >= to -90 and <= 90 | 0
|
| tickLabelSize | the 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"
|
| tickLabelStrokeColor | the stroke color to use for the axis tick labels text | should be a valid svg color | "none"
|
| tickLabelStrokeOpacity | the stroke opacity (0 - 1) to use for the axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelStrokeWidth | the stroke width (in pixels) to use for the axis tick labels text | should be a number >= to 0 | 0
|
| tickLabelSuffix | the 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
|
| tickLabelTruncationEnabled | whether 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)
|
| tickLabelTruncationMaxPercent | the maximum percentage (0 - 1) of the chart bounds to allow any tick label text to occupy when they are perpendicular to the axis | should be a number >= to 0 and <= 1 | 0.2
|
| tickLabelTruncationMinLength | the minimum length at which to apply tick label truncation if the maximum percentage settings is used | should be a number >= to 0 | 0
|
| tickLabelTruncationValue | the truncation text to append to the axis tick label text when its content is truncated | should be a string | "…"
|
| tickMarkColor | the color of the axis tick mark lines | should be a valid svg color | |
| tickMarkMargin | the margin (in pixels) to show between the inside of the axis and the axis tick mark lines | should be a number >= to 0 | 0
|
| tickMarkOpacity | the opacity (0 - 1) of the axis tick mark lines | should be a number >= to 0 and <= 1 | 1
|
| tickMarkSize | the length (in pixels) of the axis tick mark lines | should be a number >= to 0 | 3
|
| tickMarkWidth | the stroke width (in pixels) of axis the tick mark lines | should be a number >= to 0 | 1
|
| tickMarks | whether to show lines perpendicular to each tick value along the axis | should be a boolean | true
|
| title | the 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
|
| titleFillColor | the fill color of the axis title text | should be a valid svg color | |
| titleFillOpacity | the fill opacity (0 - 1) of the axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleInsideMargin | the margin (in pixels) to show between the axis title and the inside of the axis | should be a number >= to 0 | 5
|
| titleOutsideMargin | the margin (in pixels) to show between the axis title and the outside of the axis | should be a number >= to 0 | 5
|
| titleSize | the 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"
|
| titleStrokeColor | the stroke color of the axis title text | should be a valid svg color | "none"
|
| titleStrokeOpacity | the stroke opacity (0 - 1) of the axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleStrokeWidth | the stroke width (in pixels) of the axis title text | should be a number >= to 0 | 0
|
| titleTruncationEnabled | whether to apply text truncation to the contents of the axis title when it would overflow the axis bounds | should be a boolean | true
|
| titleTruncationValue | the truncation text to append to the axis title when its length exceeds the bounds of the axis | should be a string | "…"
|
| type | the type of the displayed group values (number, date, string) | should be one of [ "number", "date", "string" ] | "string"
|
| valueFormat | the 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"
|
| valueLabel | the label to show before a group value in the tooltip (use null for none) | should be a string or be equal to null | null
|
| valuePrefix | the 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
|
| valueSuffix | the 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
|
| visible | whether the axis should be visible | should be a boolean | true
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| align | the alignment for the legend (left, center, right) | should be one of [ "left", "center", "right" ] | "center"
|
| alignedToAxes | whether the legend should be centered between the axes (true) or the chart bounds (false) | should be a boolean | true
|
| backgroundStyle | the 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}
|
| filterOnClick | whether to suppress a series when the series icon or title is clicked | should be a boolean | true
|
| focusOnClick | whether to focus a series when the series icon or title is clicked | should be a boolean | false
|
| focusOnMouseOver | whether to focus a series when the mouse is moved over the series icon or title | should be a boolean | true
|
| iconBorderColor | the color of the border drawn around series icons | should be a valid color | |
| iconBorderSize | the width (in pixels) of the border drawn around series icons | should be a number >= to 0 | 1
|
| iconSize | the width and height (in pixels) of the series icons | should be a number >= to 0 | 14
|
| iconSpacerSize | the horizontal space (in pixels) to show between series icons and titles | should be a number >= to 0 | 4
|
| iconSuppressedColor | the color to use for the series icon when the corresponding series is suppressed | should be a valid color | |
| iconUnsuppressedColor | the color to use for the placeholder series icons when the corresponding series is not suppressed | should be a valid color | |
| itemBackgroundStyle | the 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}
|
| itemMargin | the margin (in pixels) for the top, right, bottom and left sides of the legend items | should 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}
|
| itemPadding | the padding (in pixels) for the top, right, bottom and left sides of the legend items | should 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}
|
| margin | the margin (in pixels) for the top, right, bottom and left sides of the legend | should 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}
|
| padding | the padding (in pixels) for the top, right, bottom and left sides of the legend | should 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}
|
| position | the position of the legend relative to the chart (top or bottom) | should be one of [ "top", "bottom" ] | "bottom"
|
| showIconColors | whether to show series colors next to series titles in the legend | should be a boolean | true
|
| showIconPlaceholders | whether to show placeholder icons next to the series titles in the legend | should be a boolean | true
|
| showIconShapes | whether to show series marker shape next to series titles in the legend | should be a boolean | true
|
| truncationEnabled | whether to use text truncation when a legend item width exceeds the width of the chart | should be a boolean | true
|
| truncationValue | the truncation text to append to legend item text when its length exceeds the length of the chart | should be a string | "…"
|
| visible | whether the legend should be visible | should be a boolean | true (when seriesConfigs.length is > 1)
false (when seriesConfigs.length is <= 1)
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| id | the 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)
|
| rotation | the rotation property (in degrees) of the svg linear gradient | should be a number >= to -360 and <= 360 | 0
|
| stops | the list of svg gradient stops, with offet, color and opacity properties | should 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 } | |
| x1 | the x1 property of the svg linear gradient | should be a number >= to 0 and <= 1 | 0
|
| x2 | the x2 property of the svg linear gradient | should be a number >= to 0 and <= 1 | 1
|
| y1 | the x3 property of the svg linear gradient | should be a number >= to 0 and <= 1 | 0
|
| y2 | the x4 property of the svg linear gradient | should be a number >= to 0 and <= 1 | 1
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| backgroundStyle | the 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}
|
| inverted | whether the group axis should be left to right (false) or top to bottom (true) | should be a boolean | false
|
| margin | the margin (in pixels) for the top, right, bottom and left sides of the plot | should 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}
|
| padding | the padding (in pixels) for the top, right, bottom and left sides of the plot | should 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}
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| cx | the cx property of the svg radial gradient | should be a number >= to 0 and <= 1 | 0.5
|
| cy | the cy property of the svg radial gradient | should be a number >= to 0 and <= 1 | 0.5
|
| fx | the fx property of the svg radial gradient | should be a number >= to 0 and <= 1 | 0.5
|
| fy | the fy property of the svg radial gradient | should be a number >= to 0 and <= 1 | 0.5
|
| id | the 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)
|
| r | the r property of the svg radial gradient | should be a number >= to 0 and <= 1 | 0.5
|
| rotation | the rotation property (in degrees) of the svg radial gradient | should be a number >= to -360 and <= 360 | 0
|
| stops | the list of svg gradient stops, with offet, color and opacity properties | should 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 } |
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| adjustForSuppression | whether to adjust the domain of the axis as series belonging to it are suppressed | should be a boolean | false
|
| adjustTickLabelSizeForSuppression | whether to adjust the size of the axis tick label bounds as series belonging to it are suppressed | should be a boolean | false
|
| alwaysVisible | whether the axis should be visible when all series belonging to it are suppressed | should be a boolean | true
|
| axisLine | whether to show a line along the length of the axis | should be a boolean | true
|
| axisLineColor | the color of the line shown along the axis | should be a valid svg color | |
| axisLineDashArray | the 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
|
| axisLineDefocusedColor | the color of the line shown along an defocused axis | should be a valid svg color | |
| axisLineDefocusedOpacity | the opacity (0 - 1) of the line shown along an defocused axis | should be a number >= to 0 and <= 1 | 0.5
|
| axisLineFocusedColor | the color of the line shown along a focused axis | should be a valid svg color | |
| axisLineFocusedOpacity | the opacity (0 - 1) of the line shown along a focused axis | should be a number >= to 0 and <= 1 | 1
|
| axisLineMargin | the margin (in pixels) between the line shown along the axis and the inner boundary of the axis | should be a number >= to 0 | 0
|
| axisLineOpacity | the opacity (0 - 1) of the line shown along the axis | should be a number >= to 0 and <= 1 | 1
|
| axisLineWidth | the stroke width (in pixels) of the line shown along the axis | should be a number >= to 0 | 1
|
| base | the 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)
|
| before | whether the axis should be position before (top/left) or after (bottom/right) the chart | should be a boolean | true
|
| collapsed | whether the axis should consume space in the layout (false) or not (true) | should be a boolean | false
|
| focusOnClick | whether the series axis should be focused whenever the user clicks/taps a part of it in the chart | should be a boolean | false
|
| focusOnMouseOver | whether the series axis should be focused whenever the user mouses over a part of it in the chart | should be a boolean | true
|
| focusTickMarkColor | the color of the focus tick mark line(s) | should be a valid svg color | |
| focusTickMarkMargin | the 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
|
| focusTickMarkOpacity | the opacity (0 - 1) of the focus tick mark line(s) | should be a number >= to 0 and <= 1 | 1
|
| focusTickMarkSize | the length (in pixels) of the focus tick mark line(s) | should be a number >= to 0 | 9
|
| focusTickMarkWidth | the stroke width (in pixels) of the focus tick mark line(s) | should be a number >= to 0 | 3
|
| focusTickMarks | whether to show lines perpendicular to the axis showing the focused series domain or group value | should be a boolean | true
|
| gridLineColor | the color of the axis grid lines | should be a valid svg color | |
| gridLineDashArray | the 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"
|
| gridLineDefocusedColor | the color of the defocused axis grid lines | should be a valid svg color | |
| gridLineDefocusedOpacity | the opacity (0 - 1) of the defocused axis grid lines | should be a number >= to 0 and <= 1 | 0.5
|
| gridLineFocusedColor | the color of the focused axis grid lines | should be a valid svg color | |
| gridLineFocusedOpacity | the opacity (0 - 1) of the focused axis grid lines | should be a number >= to 0 and <= 1 | 1
|
| gridLineOpacity | the opacity (0 - 1) of the axis grid lines | should be a number >= to 0 and <= 1 | 1
|
| gridLineWidth | the stroke width (in pixels) of the axis grid lines | should be a number >= to 0 | 1
|
| gridLines | whether to show grid lines perpendicular to each tick on the axis | should be a boolean | false
|
| id | the 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)
|
| max | the forced maximum numeric value for the axis (use "auto" to compute from the values) | should be a number or be equal to "auto" | "auto"
|
| maxMarginPercent | the 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
|
| maxOffset | the numeric offset to apply to the maximum value of the axis | should be a number | 0
|
| maxTickCount | the 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
|
| min | the forced minimum numeric value for the axis (use "auto" to compute from the values) | should be a number or be equal to "auto" | "auto"
|
| minMarginPercent | the 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
|
| minOffset | the numeric offset to apply to the minimum value of the axis | should be a number | 0
|
| minTickInterval | the minimum value interval to use between any two consecutive tick label values | should be a number >= to 0 | 0
|
| minTickSpacing | the minimum space (in pixels) to allow between the the bounds of any tick label text | should be a number >= to 0 | 12
|
| order | the unique order number of the series axis controlling its order of appearance | should be a number should be unique | ${index} (series axis index)
|
| scale | the scale of the series axis, must be linear | should be equal to "linear" | "linear"
|
| softMax | the forced maximum numeric value for the axis to be used if no data value is greater than this value (use null to disable) | should be a number or be equal to null | null
|
| softMin | the forced minimum numeric value for the axis to be used if no data value is less than this value (use null to disable) | should be a number or be equal to null | null
|
| tickCount | the 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"
|
| tickLabelAnchor | the 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"
|
| tickLabelDefocusedFillColor | the fill color to use for the defocused axis tick labels text | should be a valid svg color | |
| tickLabelDefocusedFillOpacity | the fill opacity (0 - 1) to use for the defocused axis tick labels text | should be a number >= to 0 and <= 1 | 0.5
|
| tickLabelDefocusedStrokeColor | the stroke color to use for the defocused axis tick labels text | should be a valid svg color | "none"
|
| tickLabelDefocusedStrokeOpacity | the stroke opacity (0 - 1) to use for the defocused axis tick labels text | should be a number >= to 0 and <= 1 | 0.5
|
| tickLabelFillColor | the fill color to use for the axis tick labels text | should be a valid svg color | |
| tickLabelFillOpacity | the fill opacity (0 - 1) to use for the axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelFocusedFillColor | the fill color to use for the focused axis tick labels text | should be a valid svg color | |
| tickLabelFocusedFillOpacity | the fill opacity (0 - 1) to use for the focused axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelFocusedStrokeColor | the stroke color to use for the focused axis tick labels text | should be a valid svg color | "none"
|
| tickLabelFocusedStrokeOpacity | the stroke opacity (0 - 1) to use for the focused axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelFormat | the d3 format string to be applied to the series values when displayed in axis tick labels (use null for none, use "auto" to derive from data) | should be a valid number format or be one of [ null, "auto" ] | "auto"
|
| tickLabelInsideMargin | the margin (in pixels) to show between the tick labels and the inside of the axis | should be a number >= to 0 | 6
|
| tickLabelOutsideMargin | the margin (in pixels) to show between the tick labels and the outside of the axis | should be a number >= to 0 | 5
|
| tickLabelPrefix | the 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
|
| tickLabelRotation | the rotation (in degrees) to apply to each axis tick label | should be a number >= to -90 and <= 90 | 0
|
| tickLabelSize | the 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"
|
| tickLabelStrokeColor | the stroke color to use for the axis tick labels text | should be a valid svg color | "none"
|
| tickLabelStrokeOpacity | the stroke opacity (0 - 1) to use for the axis tick labels text | should be a number >= to 0 and <= 1 | 1
|
| tickLabelStrokeWidth | the stroke width (in pixels) to use for the axis tick labels text | should be a number >= to 0 | 0
|
| tickLabelSuffix | the 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
|
| tickMarkColor | the color of the axis tick mark lines | should be a valid svg color | |
| tickMarkDefocusedColor | the color of the defocused axis tick mark lines | should be a valid svg color | |
| tickMarkDefocusedOpacity | the opacity (0 - 1) of the defocused axis tick mark lines | should be a number >= to 0 and <= 1 | 0.5
|
| tickMarkFocusedColor | the color of the focused axis tick mark lines | should be a valid svg color | |
| tickMarkFocusedOpacity | the opacity (0 - 1) of the focused axis tick mark lines | should be a number >= to 0 and <= 1 | 1
|
| tickMarkMargin | the margin (in pixels) to show between the inside of the axis and the axis tick mark lines | should be a number >= to 0 | 0
|
| tickMarkOpacity | the opacity (0 - 1) of the axis tick mark lines | should be a number >= to 0 and <= 1 | 1
|
| tickMarkSize | the length (in pixels) of the axis tick mark lines | should be a number >= to 0 | 3
|
| tickMarkWidth | the stroke width (in pixels) of axis the tick mark lines | should be a number >= to 0 | 1
|
| tickMarks | whether to show lines perpendicular to each tick value along the axis | should be a boolean | true
|
| title | the 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
|
| titleDefocusedFillColor | the fill color of the defocused axis title text | should be a valid svg color | |
| titleDefocusedFillOpacity | the fill opacity (0 - 1) of the defocused axis title text | should be a number >= to 0 and <= 1 | 0.5
|
| titleDefocusedStrokeColor | the stroke color of the defocused axis title text | should be a valid svg color | "none"
|
| titleDefocusedStrokeOpacity | the stroke opacity (0 - 1) of the defocused axis title text | should be a number >= to 0 and <= 1 | 0.5
|
| titleFillColor | the fill color of the axis title text | should be a valid svg color | |
| titleFillOpacity | the fill opacity (0 - 1) of the axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleFocusedFillColor | the fill color of the focused axis title text | should be a valid svg color | |
| titleFocusedFillOpacity | the fill opacity (0 - 1) of the focused axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleFocusedStrokeColor | the stroke color of the focused axis title text | should be a valid svg color | "none"
|
| titleFocusedStrokeOpacity | the stroke opacity (0 - 1) of the focused axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleInsideMargin | the margin (in pixels) to show between the axis title and the inside of the axis | should be a number >= to 0 | 5
|
| titleOutsideMargin | the margin (in pixels) to show between the axis title and the outside of the axis | should be a number >= to 0 | 5
|
| titleSize | the 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"
|
| titleStrokeColor | the stroke color of the axis title text | should be a valid svg color | "none"
|
| titleStrokeOpacity | the stroke opacity (0 - 1) of the axis title text | should be a number >= to 0 and <= 1 | 1
|
| titleStrokeWidth | the stroke width (in pixels) of the axis title text | should be a number >= to 0 | 0
|
| titleTruncationEnabled | whether to apply text truncation to the contents of the axis title when it would overflow the axis bounds | should be a boolean | true
|
| titleTruncationValue | the truncation text to append to the axis title when its length exceeds the bounds of the axis | should be a string | "…"
|
| type | the type of the series axis, must be number | should be equal to "number" | "number"
|
| useSeriesFocus | whether to show the axis as focused when any series belonging to is focused | should be a boolean | true
|
| visible | whether the axis should be visible | should be a boolean | true
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| animateBaseFromAdjacent | whether 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)
|
| axis | the 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)
|
| capExpand | whether to expand the base of caps on a bar series when the size of the cap is greater than the extent of the bar | should be a boolean | true
|
| capOnlyStackOuter | whether to only show the cap on bars in the series when they are an outer series of a stack | should be a boolean | false
|
| capSize | the size of the cap (in pixels) to use when drawing caps on a bar series | should be a number >= to 0 | 5
|
| capType | the type (point, curve, round, use null for none) of cap to use when drawing caps on a bar series | should be one of [ "point", "curve", "round" ] or be equal to null | null
|
| colorBase | the 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
|
| colorBaseAboveMax | the 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)
|
| colorBaseAboveMin | the 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)
|
| colorBaseBelowMax | the 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)
|
| colorBaseBelowMin | the 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)
|
| colorInterpolation | the 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)
|
| colorMax | the 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)
|
| colorMin | the 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)
|
| colorProperty | the 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
|
| curve | the d3 curve type and param to use when drawing the series shape | should 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"}
|
| defocusedFillColor | the 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"
|
| defocusedFillOpacity | the defocused fill opacity (0 - 1) of the series shape | should 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)
|
| defocusedStrokeColor | the 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"
|
| defocusedStrokeOpacity | the defocused stroke opacity (0 - 1) of the series shape | should 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)
|
| defocusedStrokeWidth | the defocused stroke width (in pixels) of the series shape | should 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)
|
| fillColor | the 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"
|
| fillOpacity | the fill opacity (0 - 1) of the series shape | should 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)
|
| focusGroupOnClick | whether the group should be focused whenever the user clicks/taps a group of the series in the chart | should be a boolean | false
|
| focusGroupOnMouseOver | whether the group should be focused whenever the user mouses over a group of the series in the chart | should be a boolean | false
|
| focusOnClick | whether the series should be focused whenever the user clicks/taps a part of it in the chart | should be a boolean | false
|
| focusOnMouseOver | whether the series should be focused whenever the user mouses over a part of it in the chart | should be a boolean | false
|
| focusedFillColor | the 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"
|
| focusedFillOpacity | the focused fill opacity (0 - 1) of the series shape | should 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)
|
| focusedStrokeColor | the 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"
|
| focusedStrokeOpacity | the focused stroke opacity (0 - 1) of the series shape | should 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)
|
| focusedStrokeWidth | the focused stroke width (in pixels) of the series shape | should 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)
|
| gradient | the 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)
|
| group | the 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)
|
| id | the unique identifier for the series | should be a string should be unique | S${index} (series index)
|
| ignore | whether to ignore this series and treat it as though it were not specified | should be a boolean | false
|
| labelAboveBaseMaxPositionPercent | the 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"
|
| labelAboveBaseMinPositionPercent | the 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"
|
| labelAboveBaseOffset | the 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"
|
| labelAboveBasePosition | whether to position the series labels inside or outside of the series shape for series shapes that are above the base value | should be one of [ "auto", "inside", "center", "outside" ] | "auto"
|
| labelBelowBaseMaxPositionPercent | the 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"
|
| labelBelowBaseMinPositionPercent | the 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"
|
| labelBelowBaseOffset | the 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"
|
| labelBelowBasePosition | whether to position the series labels inside or outside of the series shape for series shapes that are below the base value | should be one of [ "auto", "inside", "center", "outside" ] | "auto"
|
| labelDefocusedFillColor | the 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"
|
| labelDefocusedFillOpacity | the defocused fill opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 1
|
| labelDefocusedStrokeColor | the 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"
|
| labelDefocusedStrokeOpacity | the defocused stroke opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 1
|
| labelDefocusedStrokeWidth | the defocused stroke width (in pixels) for the series label text | should be a number >= to 0 | 1
|
| labelFillColor | the 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" ] | |
| labelFillOpacity | the fill opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 0.8
|
| labelFocusedFillColor | the 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"
|
| labelFocusedFillOpacity | the focused fill opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 1
|
| labelFocusedStrokeColor | the 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"
|
| labelFocusedStrokeOpacity | the focused stroke opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 1
|
| labelFocusedStrokeWidth | the focused stroke width (in pixels) for the series label text | should be a number >= to 0 | 1
|
| labelFormat | the 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"
|
| labelMaxPositionPercent | the 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
|
| labelMinPositionPercent | the 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
|
| labelMinRangePercent | the 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
|
| labelOffset | the series position offset (in pixels) to apply to all series label positions | should be a number | 0
|
| labelPosition | whether to position the series labels inside or outside of the series shape | should be one of [ "inside", "center", "outside" ] | "center"
|
| labelProperty | the 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
|
| labelStrokeColor | the 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" ] | |
| labelStrokeOpacity | the stroke opacity (0 - 1) for the series label text | should be a number >= to 0 and <= 1 | 0.8
|
| labelStrokeWidth | the stroke width (in pixels) for the series label text | should be a number >= to 0 | 1
|
| markerDefocusedFillColor | the 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"
|
| markerDefocusedFillOpacity | the defocused fill opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 0.8
|
| markerDefocusedStrokeColor | the 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"
|
| markerDefocusedStrokeOpacity | the defocused stroke opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 0.8
|
| markerDefocusedStrokeWidth | the defocused stroke width (in pixels) for the series marker shape | should be a number >= to 0 | 1
|
| markerFillColor | the 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"
|
| markerFillOpacity | the fill opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 0.9
|
| markerFocusedFillColor | the 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"
|
| markerFocusedFillOpacity | the focused fill opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 1
|
| markerFocusedStrokeColor | the 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"
|
| markerFocusedStrokeOpacity | the focused stroke opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 1
|
| markerFocusedStrokeWidth | the focused stroke width (in pixels) for the series marker shape | should be a number >= to 0 | 3
|
| markerProperty | the 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
|
| markerShape | the 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)
|
| markerShowMissing | whether to show the marker when the value is missing (can be used in conjunction with showMissingAtBase) | should be a boolean | false
|
| markerSize | the 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 used | should be a number >= to 0 | 6
|
| markerStrokeColor | the 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"
|
| markerStrokeOpacity | the stroke opacity (0 -1) for the series marker shape | should be a number >= to 0 and <= 1 | 0.9
|
| markerStrokeWidth | the stroke width (in pixels) for the series marker shape | should be a number >= to 0 | 1
|
| minMarkerSize | the minimum marker size (in pixels) to use when interpolating the marker size based on a marker property value | should be a number >= to 0 | 1
|
| order | the unique order number of the series controlling its order of appearance | should be a number should be unique | ${index} (series index)
|
| property | the property to retrieve from the data provider for the series values | should be a defined value | |
| rangeProperty | the 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
|
| renderer | the shape renderer to use when drawing the series shape (line, area, bar, none) | should be one of [ "bar", "line", "area", "none" ] | "line"
|
| showColorInLegend | whether to show the series color as an icon next to the series title in the legend | should be a boolean | false (when color is groupIndex)
true (when color is not groupIndex)
|
| showColorInTooltip | whether to show the series color as an icon next to the series title in the tooltip | should be a boolean | false (when color is groupIndex)
true (when color is not groupIndex)
|
| showInLegend | whether to show the series in the legend | should be a boolean | true
|
| showInTooltip | whether to show the series in the tooltip | should be a boolean | true
|
| showMissingAtBase | whether to use the series axis base value for missing values when drawing the shape for this series | should be a boolean | false
|
| skipMissing | whether to skip undefined values when drawing the shape for this series | should be a boolean | false
|
| stack | the 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)
|
| strokeColor | the 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"
|
| strokeOpacity | the stroke opacity (0 - 1) of the series shape | should 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)
|
| strokeWidth | the stroke width (in pixels) of the series shape | should 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)
|
| suppressible | whether or not the series can be suppressed from being shown in the chart | should be a boolean | true
|
| title | the title to display for the series in the legend (use null for none) | should be a string or be equal to null | null
|
| useAxisFocus | whether to show the series as focused when the series axis it belongs to is focused | should be a boolean | true
|
| useTitleForValueLabel | whether to use the title value for the valueLabel value when the valueLabel is not set | should be a boolean | true
|
| valueFormat | the d3 format string to be applied to the series value when displayed in the tooltip (use null for none, use "auto" to derive from data ("auto" will use the series axis tick label format if it is set)) | should be a valid number format or be one of [ null, "auto" ] | "auto"
|
| valueLabel | the label to show before a series value in the tooltip (use null for none) | should be a string or be equal to null | null
|
| valuePrefix | the 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
|
| valueSuffix | the 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
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| id | the 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)
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| axis | the 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)
|
| id | the 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)
|
| outerCapExpand | whether 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 bar | should be a boolean | true
|
| outerCapSize | the size of the cap (in pixels) for series that are an outer series of the stack | should be a number >= to 0 | 5
|
| outerCapType | the type (point, curve, round, use null for none) of cap for series that are an outer series of the stack | should be one of [ "point", "curve", "round" ] or be equal to null | null
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| align | the alignment for the title (left, center, right) | should be one of [ "left", "center", "right" ] | "center"
|
| alignedToAxes | whether the title should be aligned between the axes (true) or the chart bounds (false) | should be a boolean | true
|
| backgroundStyle | the 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}
|
| link | the link to create for the title (use null for none) | should be a string or be equal to null | null
|
| linkDisabled | whether to prevent default navigation behaviour when the link is clicked | should be a boolean | false
|
| margin | the margin (in pixels) for the top, right, bottom and left sides of the title | should 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}
|
| padding | the padding (in pixels) for the top, right, bottom and left sides of the title | should 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}
|
| position | the position of the title relative to the chart (top or bottom) | should be one of [ "top", "bottom" ] | "top"
|
| prefixBackgroundStyle | the 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}
|
| prefixMargin | the margin (in pixels) for the top, right, bottom and left sides of the title prefix | should 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}
|
| prefixPadding | the padding (in pixels) for the top, right, bottom and left sides of the title prefix | should 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}
|
| prefixTextStyle | the 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}
|
| suffixBackgroundStyle | the 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}
|
| suffixMargin | the margin (in pixels) for the top, right, bottom and left sides of the title suffix | should 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}
|
| suffixPadding | the padding (in pixels) for the top, right, bottom and left sides of the title suffix | should 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}
|
| suffixTextStyle | the 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}
|
| textMargin | the margin (in pixels) for the top, right, bottom and left sides of the title text | should 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}
|
| textPadding | the padding (in pixels) for the top, right, bottom and left sides of the title text | should 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}
|
| title | the 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
|
| titleBackgroundStyle | the 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}
|
| titlePrefix | the 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
|
| titleSuffix | the 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
|
| titleTextStyle | the 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}
|
| truncationEnabled | whether to use text truncation when the title width exceeds the width of the chart | should be a boolean | true
|
| truncationValue | the truncation text to append to the title when its length exceeds the length of the chart | should be a string | "…"
|
| verticalAlign | the vertical alignment of the prefix/text/suffix within the title | should be one of [ "top", "middle", "bottom" ] | "middle"
|
| verticalExpand | whether to expand the padding height of the prefix/text/suffix to match the max section height | should be a boolean | false
|
| Property | Description | Validation Rules | Default |
|---|---|---|---|
| adjustForSuppression | whether to adjust the series values when series suppression changes | should be a boolean | true
|
| adjustSizeForSuppression | whether to adjust the width of the tooltip when the series values change due to suppression changes | should be a boolean | false
|
| alignValues | whether to right-align the values shown in the tooltip | should be a boolean | true
|
| applyFocus | whether to change the focused group as the tooltip is shown or hidden | should be a boolean | true
|
| backgroundColor | the background color for the interior of the tooltip | should be a valid color | |
| borderColor | the color of the border around the tooltip | should be a valid color | |
| borderRadius | the radius (in pixels) of the corners of the tooltip | should be a number >= to 0 | 4
|
| borderWidth | the width (in pixels) of the the border around the tooltip | should be a number >= to 0 | 2
|
| closeOnClick | whether to hide the tooltip when the user clicks/taps within it | should be a boolean | true
|
| dropShadowBlurRadius | the blur radius (in pixels) of the drop shadow effect used for the tooltip | should be a number >= to 0 | 10
|
| dropShadowColor | the color of the drop shadow effect used for the tooltip | should be a valid color | |
| dropShadowOffsetX | the x offset (in pixels) of the drop shadow effect used for the tooltip | should be a number >= to 0 | 0
|
| dropShadowOffsetY | the y offset (in pixels) of the drop shadow effect used for the tooltip | should be a number >= to 0 | 5
|
| filterOnSeriesClick | whether series should be filtered when the user clicks/taps on them in the tooltip | should be a boolean | false
|
| focusOnGroupClick | whether group values should be focused when the user clicks/taps on them in the tooltip | should be a boolean | false
|
| focusOnGroupMouseOver | whether group values should be focused when the user mouses over them in the tooltip | should be a boolean | false
|
| focusOnSeriesClick | whether series should be focused when the user clicks/taps on them in the tooltip | should be a boolean | false
|
| focusOnSeriesMouseOver | whether series should be focused when the user mouses over them in the tooltip | should be a boolean | false
|
| hideSuppressed | whether to hide series that have been suppressed from the tooltip | should be a boolean | false
|
| iconBorderColor | the color of the border drawn around series icons | should be a valid color | |
| iconBorderSize | the width (in pixels) of the border drawn around series icons | should be a number >= to 0 | 1
|
| iconSize | the width and height (in pixels) of the series icons | should be a number >= to 0 | 14
|
| iconSpacerSize | the horizontal space (in pixels) to show between series icons and titles | should be a number >= to 0 | 4
|
| iconSuppressedColor | the color to use for the series icon when the corresponding series is suppressed | should be a valid color | |
| iconUnsuppressedColor | the color to use for the placeholder series icons when the corresponding series is not suppressed | should be a valid color | |
| keepInside | whether to keep the tooltip within the series drawing area (true) or allow it to overlap the axes (false) | should be a boolean | false
|
| linePadding | the padding (in pixels) betwen each line of the tooltip | should be a number >= to 0 | 3
|
| minWidth | the minimum width (in pixels) for the tooltip | should be a number >= to 0 | 120
|
| missingValueText | the text to show for series that do not have defined values | should be a string | "N/A"
|
| mouseOver | whether the tooltip should be track the mouse position in the chart drawing area | should be a boolean | false
|
| padding | the padding (in pixels) to show on each side of the tooltip | should be a number >= to 0 | 2
|
| rangeValueText | the text to use when joining the values for a series that has more than one value | should be a string | " - "
|
| showControls | whether the focus/filter controls should be shown at the top of the tooltip | should be a boolean | false
|
| showIconColors | whether to show series colors next to series titles in the tooltip | should be a boolean | true
|
| showIconPlaceholders | whether to show placeholder icons next to the series titles in the tooltip | should be a boolean | true
|
| showIconShapes | whether to show series marker shape next to series titles in the tooltip | should be a boolean | true
|
| showMissingValues | whether to show series that do not have defined values in the tooltip | should be a boolean | true
|
| snapToGroup | whether the tooltip should be centered at the closest group value (true) or at the click/tap position (false) | should be a boolean | true
|
| suppressedValueCharacter | the 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 | "-"
|
| suppressedValueText | the text to show for series that have been suppressed (use null for none) | should be a string or be equal to null | null
|
| visible | whether or not to show the tooltip | should be a boolean | true
|