grafit-charts

---

Interface: SankeySeriesOptions

Extends

• FlowSeriesBaseOptions

Properties

fills?

optional fills?: string[]

Inherited from

FlowSeriesBaseOptions.fills

---

fromField

fromField: string

---

id?

optional id?: string

Inherited from

FlowSeriesBaseOptions.id

---

label?

optional label?: Switchable & FontOptions & PartLabelBlockOptions<FlowLabelFormatterParams> & object

Node labels: the name of a node and what flows through it, drawn as one block so the two always read together — each half with its own font and its own format, layout putting the value on a line of its own (default) or in the same row behind a separator. The name is printed on its own until value.enabled asks for the number too, as on a pie.

Type Declaration

formatter?

optional formatter?: (params) => string

The whole label at once; it wins over category/value.

Parameters

params

FlowLabelFormatterParams

Returns

string

Inherited from

FlowSeriesBaseOptions.label

---

linkOpacity?

optional linkOpacity?: number

Opacity of the flow ribbons (0.35 by default).

---

name?

optional name?: string

Name of what the value of a node measures — the label of the tooltip row. Without it the row is named by the data key the value came from, which is the name of a column, not of a measure.

Inherited from

FlowSeriesBaseOptions.name

---

node?

optional node?: object

spacing?

optional spacing?: number

width?

optional width?: number

---

nodeStyler?

optional nodeStyler?: Styler<FlowNodeStylerParams, FlowNodeStyle>

Style of one node by its name. Undefined leaves the node its palette color; a partial style is laid over it. A link takes the color of the node it flows out of, styled or not.

Inherited from

FlowSeriesBaseOptions.nodeStyler

---

showInLegend?

optional showInLegend?: boolean

Inherited from

FlowSeriesBaseOptions.showInLegend

---

sizeField

sizeField: string

---

toField

toField: string

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

NodeTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

FlowSeriesBaseOptions.tooltip

---

type

type: "sankey"

---

visible?

optional visible?: boolean

Inherited from

FlowSeriesBaseOptions.visible