Skip to main content

Interface: SankeyDiagramOptions

Defined in: src/mobjects/graph/SankeyDiagram.ts:34

Options for SankeyDiagram.

Properties​

height?​

optional height: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:46

Target length of the tallest column. Default: 4

labelBuff?​

optional labelBuff: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:56

Gap between a node and its label. Default: 0.15

labelFontSize?​

optional labelFontSize: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:54

Label font size. Default: 24

layerSpacing?​

optional layerSpacing: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:44

Distance between adjacent columns. Default: 3

linkColorMode?​

optional linkColorMode: SankeyLinkColorMode

Defined in: src/mobjects/graph/SankeyDiagram.ts:62

How a link colors itself from its endpoints. Default: 'source'

linkOpacity?​

optional linkOpacity: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:60

Link (ribbon) fill opacity. Default: 0.5

links: SankeyLinkInput[]

Defined in: src/mobjects/graph/SankeyDiagram.ts:38

Directed flows between nodes.

minNodeLength?​

optional minNodeLength: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:48

Minimum node length along the stacking axis. Default: 0.05

nodeFillOpacity?​

optional nodeFillOpacity: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:58

Node fill opacity. Default: 1

nodePadding?​

optional nodePadding: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:42

Gap between stacked nodes in one column. Default: 0.4

nodes​

nodes: SankeyNodeInput[]

Defined in: src/mobjects/graph/SankeyDiagram.ts:36

Nodes keyed by id.

nodeWidth?​

optional nodeWidth: number

Defined in: src/mobjects/graph/SankeyDiagram.ts:40

Node thickness along the flow axis. Default: 0.3

orientation?​

optional orientation: SankeyOrientation

Defined in: src/mobjects/graph/SankeyDiagram.ts:50

Flow direction. Default: 'horizontal'

showLabels?​

optional showLabels: boolean

Defined in: src/mobjects/graph/SankeyDiagram.ts:52

Whether to render node labels. Default: true