API / Series/Sankey / SankeySeries
Defined in: src/core/types/chart/sankey.ts:16
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
T |
MeaningfulAny |
Properties
| Property | Type | Description |
|---|---|---|
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 |
SankeySeriesData<T>[] |
- |
dataLabels? |
BaseDataLabels |
Options for the series data labels, appearing next to each data point. |
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). |
tooltip? |
object |
Options for the tooltip that appears when the user hovers over a series or point. |
tooltip.enabled? |
boolean |
Enable or disable the visibility of this series in the tooltip. Default true |
tooltip.valueFormat? |
ValueFormat |
Formatting settings for tooltip value. |
type |
"sankey" |
- |
visible? |
boolean |
Initial visibility of the series |
Previous
Next