API / Series/Waterfall / WaterfallSeries
Defined in: src/types/chart/waterfall.ts:28
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
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. |
data |
WaterfallSeriesData<T>[] |
- |
dataLabels? |
BaseDataLabels |
Options for the series data labels, appearing next to each data point. |
legend? |
ChartLegendItem & 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). |
negativeColor? |
string |
The color used for negative values. If it is not specified, the general color of the series is used. |
nullMode? |
"zero" | "skip" |
Defines how to handle null values in the data. - 'zero': Treat null values as zero - 'skip': Omit data points with null values (don't render them) Default 'skip' |
positiveColor? |
string |
The color used for positive values. If it is not specified, the general color of the series is used. |
tooltip? |
object |
Options for the tooltip that appears when the user hovers over a series or point. |
tooltip.valueFormat? |
ValueFormat |
Formatting settings for tooltip value. |
type |
"waterfall" |
- |
visible? |
boolean |
Initial visibility of the series |
Previous