Chart Config
Configure general settings of the chart.
- Validation: should be an object with any of the properties {
backgroundStyle,margin,padding,type}
Every property is optional and falls back to its default. Property anchors are stable: link to any entry as #chart.propertyName, and to a member of a nested property as #chart.propertyName.memberName.
backgroundStyle
The styles to apply to the chart background (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).
- Default:
{ strokeColor: "currentColor", strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: null, fillOpacity: 0 } - Validation: should be an object with any of the properties {
fillColor,fillOpacity,strokeColor,strokeDashArray,strokeOpacity,strokeWidth} - Used in: Layout and spacing · Truncated Text
backgroundStyle.fillColor
The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.
- Default:
null - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to null - Used in: Layout and spacing · Truncated Text
backgroundStyle.fillOpacity
The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.
- Default:
0 - Validation:
should be a number >= to 0 and <= 1 or be equal to null - Used in: Layout and spacing · Truncated Text
backgroundStyle.strokeColor
The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.
- Default:
"currentColor" - Validation:
should be a valid svg color (or "none" / "currentColor") or be equal to null - Used in: Layout and spacing · Truncated Text
backgroundStyle.strokeDashArray
The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.
- Default:
null - Validation:
should be a valid dash array or be equal to null
backgroundStyle.strokeOpacity
The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.
- Default:
0 - Validation:
should be a number >= to 0 and <= 1 or be equal to null - Used in: Layout and spacing · Truncated Text
backgroundStyle.strokeWidth
The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.
- Default:
null - Validation:
should be a number >= to 0 or be equal to null - Used in: Layout and spacing · Truncated Text
margin
The margin (in pixels) for the top, right, bottom and left sides of the chart.
- Default:
{ top: 2, right: 2, bottom: 2, left: 2 } - Validation: should be an object with any of the properties {
bottom,left,right,top} - Used in: Sparklines · Scatter and bubble · Layout and spacing · Truncated Text
margin.bottom
The space (in pixels) along the bottom edge.
- Default:
2 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
margin.left
The space (in pixels) along the left edge.
- Default:
2 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
margin.right
The space (in pixels) along the right edge.
- Default:
2 - Validation:
should be a number >= to 0 - Used in: Sparklines · Scatter and bubble · Layout and spacing · Truncated Text
margin.top
The space (in pixels) along the top edge.
- Default:
2 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
padding
The padding (in pixels) for the top, right, bottom and left sides of the chart.
- Default:
{ top: 3, right: 3, bottom: 3, left: 3 } - Validation: should be an object with any of the properties {
bottom,left,right,top} - Used in: Sparklines · Layout and spacing · Truncated Text
padding.bottom
The space (in pixels) along the bottom edge.
- Default:
3 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
padding.left
The space (in pixels) along the left edge.
- Default:
3 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
padding.right
The space (in pixels) along the right edge.
- Default:
3 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
padding.top
The space (in pixels) along the top edge.
- Default:
3 - Validation:
should be a number >= to 0 - Used in: Sparklines · Layout and spacing · Truncated Text
type
The type of chart to render: an x/y plot with axes (xy) or a pie/donut chart (pie).
- Default:
"xy" - Validation:
should be one of [ "xy", "pie" ] - Used in: Pie and donut · Pie · Donut · Gauge