IChartSankeyProps

interface
Chart

Props for <OrigamChartSankey>. The component consumes series[0] only — each item in series[0].data must conform to IChartSankeyDatum ({ from, to, value }). Nodes are inferred automatically; columns are assigned by topological depth. Extends IChartBaseProps.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

nodeWidth
number
Width of each node rectangle in SVG pixels. Default 16.
nodePadding
number
Minimum vertical gap between sibling nodes within the same column, in SVG pixels. Default 8.
linkOpacity
number
Opacity of the flow ribbons (links). Range [0, 1]. Default 0.4.
showLabel
boolean
Whether to render node labels. Left-column nodes are right-aligned outside their rect; right-column nodes are left-aligned outside. Default true.
xAxisFormat
(value: number | string) => string
X-axis / value formatter applied to node labels and tooltip values. When omitted the raw number is displayed.
yAxisFormat
(value: number) => string
Y-axis formatter — alias kept for API symmetry with other families. Same as xAxisFormat for this geometry.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Sankey diagram showing energy flows

vue