API / Series/Bar-Y / BarYSeries
Defined in: src/core/types/chart/bar-y.ts:46
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
borderColor? |
string |
The color of the border surrounding each bar. |
borderRadius? |
number |
The corner radius of the border surrounding each bar. Default 0 |
borderWidth? |
number |
The width of the border surrounding each bar. Default 0 |
color? |
string |
The main color of the series (hex, rgba) |
cursor? |
string |
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked. |
custom? |
any |
A reserved subspace to store options and values for customized functionality Here you can add additional data for your own event callbacks and formatter callbacks |
data |
BarYSeriesData<T>[] |
- |
dataLabels? |
Omit<BaseDataLabels, "format"> & object |
Options for the series data labels, appearing next to each data point. |
grouping? |
boolean |
Whether to group non-stacked columns or to let them render independent of each other. When false columns will be laid out individually and overlap each other. Default true |
legend? |
BaseSeriesLegend & object |
Individual series legend options. Has higher priority than legend options in widget data |
name |
string |
The name of the series (used in legend, tooltip etc) |
nullMode? |
"skip" | "zero" |
Specifies how null or undefined values should be handled in the series. - 'skip': Omit data points with null values (no bar shown) - 'zero': Treat null values as zero Default 'skip' |
stackId? |
string |
This option allows grouping series in a stacked chart |
stacking? |
"percent" | "normal" |
Whether to stack the values of each series on top of each other. Possible values are undefined to disable, "normal" to stack by value or "percent" Percent stacking supports only non-negative values. |
stackLabels? |
StackLabelsOptions |
Override plugin stack label options. Only enabled series contribute to totals. |
tooltip? |
Omit<{ enabled: boolean; valueFormat: ValueFormat<CustomFormatContext>; }, "valueFormat"> & object |
Options for the tooltip that appears when the user hovers over a series or point. |
type |
"bar-y" |
Bar-Y series: horizontal bars for values along the Y axis. |
visible? |
boolean |
Initial visibility of the series |
Previous
Next