API / Series/General / ChartSeriesOptions
Defined in: src/types/chart/series.ts:77
Properties
| Property | Type | Description |
|---|---|---|
area? |
object |
- |
area.lineWidth? |
number |
Pixel width of the graph line. Default 1 |
area.marker? |
PointMarkerOptions |
Options for the point markers of line series |
area.states? |
object |
Options for the series states that provide additional styling information to the series. |
area.states.hover? |
BasicHoverState & object |
- |
area.states.inactive? |
BasicInactiveState |
- |
bar-x? |
object |
- |
bar-x.barMaxWidth? |
number |
The maximum allowed pixel width for a column. This prevents the columns from becoming too wide when there is a small number of points in the chart. Default 50 |
bar-x.barPadding? |
number |
Padding between each column or bar, in x axis units. Default 0.1 |
bar-x.borderRadius? |
number |
The corner radius of the border surrounding each bar. Default 0 |
bar-x.dataSorting? |
object |
- |
bar-x.dataSorting.direction? |
"asc" | "desc" |
Sorting direction. Default 'asc' |
bar-x.dataSorting.key? |
"y" | "name" |
Determines what data value should be used to sort by. Possible values are undefined to disable, "name" to sort by series name or "y" Default undefined |
bar-x.groupPadding? |
number |
Padding between each value groups, in x axis units Default 0.2 |
bar-x.states? |
object |
Options for the series states that provide additional styling information to the series. |
bar-x.states.hover? |
BasicHoverState |
- |
bar-x.states.inactive? |
BasicInactiveState |
- |
bar-y? |
object |
- |
bar-y.barMaxWidth? |
number |
The maximum allowed pixel width for a column. This prevents the columns from becoming too wide when there is a small number of points in the chart. Default 50 |
bar-y.barPadding? |
number |
Padding between each column or bar, in x axis units. Default 0.1 |
bar-y.borderRadius? |
number |
The corner radius of the border surrounding each bar. Default 0 |
bar-y.dataSorting? |
object |
- |
bar-y.dataSorting.direction? |
"asc" | "desc" |
Sorting direction. Default 'asc' |
bar-y.dataSorting.key? |
"x" | "name" |
Determines what data value should be used to sort by. Possible values are undefined to disable, "name" to sort by series name or "x" Default undefined |
bar-y.groupPadding? |
number |
Padding between each value groups, in x axis units Default 0.2 |
bar-y.states? |
object |
Options for the series states that provide additional styling information to the series. |
bar-y.states.hover? |
BasicHoverState |
- |
bar-y.states.inactive? |
BasicInactiveState |
- |
dataLabels? |
object |
Individual data label for each point. |
dataLabels.enabled? |
boolean |
Enable or disable the data labels |
dataLabels.renderer? |
(args: DataLabelRendererData) => SVGTextElementAttributes<SVGTextElement> |
Callback function to render the data label |
line? |
object |
- |
line.dashStyle? |
"Dash" | "DashDot" | "Dot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "ShortDash" | "ShortDashDot" | "ShortDashDotDot" | "ShortDot" | "Solid" |
Options for line style Default 'Solid' |
line.linecap? |
"square" | "butt" | "round" | "none" |
Options for line cap style Default 'round' when dashStyle is not 'solid', 'none' when dashStyle is not 'solid' |
line.lineWidth? |
number |
Pixel width of the graph line. Default 1 |
line.marker? |
PointMarkerOptions |
Options for the point markers of line series |
line.states? |
object |
Options for the series states that provide additional styling information to the series. |
line.states.hover? |
BasicHoverState & object |
- |
line.states.inactive? |
BasicInactiveState |
- |
pie? |
object |
- |
pie.states? |
object |
Options for the series states that provide additional styling information to the series. |
pie.states.hover? |
BasicHoverState & object |
- |
pie.states.inactive? |
BasicInactiveState |
- |
scatter? |
object |
- |
scatter.states? |
object |
Options for the series states that provide additional styling information to the series. |
scatter.states.hover? |
BasicHoverState & object |
- |
scatter.states.inactive? |
BasicInactiveState |
- |
treemap? |
object |
- |
treemap.states? |
object |
Options for the series states that provide additional styling information to the series. |
treemap.states.hover? |
BasicHoverState |
- |
treemap.states.inactive? |
BasicInactiveState |
- |
waterfall? |
object |
- |
waterfall.barMaxWidth? |
number |
The maximum allowed pixel width for a column. This prevents the columns from becoming too wide when there is a small number of points in the chart. Default 50 |
waterfall.barPadding? |
number |
Padding between each column or bar, in x axis units. Default 0.1 |
waterfall.states? |
object |
Options for the series states that provide additional styling information to the series. |
waterfall.states.hover? |
BasicHoverState |
- |
waterfall.states.inactive? |
BasicInactiveState |
- |
Previous