API / Series/General / ChartSeriesOptions

Defined in: src/core/types/chart/series.ts:116

Properties

Property Type Description
area? object -
area.annotation? ChartAnnotationSeriesOptions Default annotation settings for all area data points
area.lineWidth? number Pixel width of the graph line. Default 1
area.marker? PointMarkerOptions Options for the point markers of line series
area.stackLabels? StackLabelsOptions Total labels on the outer stack boundary, grouped by X value, stackId and value axis.
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 -
area-range? object Default appearance and interaction settings for area-range series.
area-range.lineWidth? number Width of both boundary lines in pixels. Default 1
area-range.marker? PointMarkerOptions Default marker options for both boundaries of area-range points.
area-range.states? object Styling of hovered and inactive bands.
area-range.states.hover? BasicHoverState & object -
area-range.states.inactive? BasicInactiveState -
bar-x? object -
bar-x.annotation? ChartAnnotationSeriesOptions Default annotation settings for all bar-x data points
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 bar as a fraction of the space allocated per bar. Default 0.2
bar-x.borderColor? string The border color. Defaults to var(--gcharts-shape-border-color). Individual series options take precedence.
bar-x.borderRadius? number The corner radius at the value end of each bar, in pixels. For stacks, only the outer ends of the positive and negative stacks are rounded. Default 0
bar-x.borderWidth? number The width of the border in pixels, drawn inside each bar. Ignored in the range slider and when the bar width or height is at most twice the border width. Individual series options take precedence. 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"
bar-x.groupPadding? number Padding between each value groups, in x axis units Default 0.1
bar-x.stackGap? number The distance between the shapes of the stacked values, in pixels. Default 1
bar-x.stackLabels? StackLabelsOptions Total labels for each visible stack, grouped by category, stackId and value axis.
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 bar as a fraction of the space allocated per bar. Default 0.2
bar-y.borderColor? string The color of the border surrounding each bar.
bar-y.borderRadius? number The corner radius of the border surrounding each bar. Default 0
bar-y.borderWidth? number The width 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"
bar-y.groupPadding? number Padding between each value groups, in x axis units Default 0.1
bar-y.stackGap? number The distance between the shapes of the stacked values, in pixels. Default 1
bar-y.stackLabels? StackLabelsOptions Total labels for each visible stack, grouped by category and stackId.
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) => object Callback function to render the data label
funnel? object -
funnel.states? object Options for the series states that provide additional styling information to the series.
funnel.states.hover? BasicHoverState -
heatmap? object -
heatmap.borderColor? string The color of the border surrounding each cell.
heatmap.borderWidth? number The width of the border surrounding each cell. Default 0
heatmap.states? object Options for the series states that provide additional styling information to the series.
heatmap.states.hover? BasicHoverState -
line? object -
line.annotation? ChartAnnotationSeriesOptions Default annotation settings for all line data points
line.dashStyle? "Dash" | "DashDot" | "Dot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "ShortDash" | "ShortDashDot" | "ShortDashDotDot" | "ShortDot" | "Solid" Options for line style Default 'Solid'
line.linecap? "none" | "square" | "butt" | "round" Options for line cap style Default 'round' when dashStyle is 'Solid', 'none' when dashStyle is not 'Solid'
line.linejoin? "round" | "bevel" | "miter" | "unset" Defines the shape to be used at the corners of the line Default 'round' when dashStyle is 'Solid', 'unset' 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 -
radar? object -
radar.marker? PointMarkerOptions Options for the point markers of radar series
radar.states? object Options for the series states that provide additional styling information to the series.
radar.states.hover? BasicHoverState & object -
radar.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 bar as a fraction of the space allocated per bar. Default 0.2
waterfall.states? object Options for the series states that provide additional styling information to the series.
waterfall.states.hover? BasicHoverState -
waterfall.states.inactive? BasicInactiveState -
x-range? object -
x-range.borderColor? string The color of the border surrounding each bar.
x-range.borderDashStyle? "Dash" | "DashDot" | "Dot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "ShortDash" | "ShortDashDot" | "ShortDashDotDot" | "ShortDot" | "Solid" The dash style of the border surrounding each bar. Default 'Solid'
x-range.borderRadius? number The corner radius of the border surrounding each bar. Default 0
x-range.borderWidth? number The width of the border surrounding each bar. Default 0
x-range.states? object Options for the series states that provide additional styling information to the series.
x-range.states.hover? BasicHoverState -
x-range.states.inactive? BasicInactiveState -
Previous
ChartSeriesData
Next
ChartSeriesRangeSliderOptions