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? |
object |
Options for the series data labels, appearing next to each data point. |
dataLabels.allowOverlap? |
boolean |
Default false |
dataLabels.enabled? |
boolean |
Enable or disable the data labels Default true |
dataLabels.html? |
boolean |
Allows to use any html-tags to display the content. The element will be displayed outside the box of the SVG element. Default false |
dataLabels.padding? |
number |
Default 5 |
dataLabels.style? |
Partial <BaseTextStyle > |
- |
legend? |
ChartLegend & 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. |
positiveColor? |
string |
The color used for positive values. If it is not specified, the general color of the series is used. |
type |
"waterfall" |
- |
visible? |
boolean |
Initial visibility of the series |
Previous