Skip to content

Interface: SankeyOptions

Defined in: charts/sankey.ts:195

Options for addSankey.

Properties

colors?

ts
optional colors?: string[];

Defined in: charts/sankey.ts:203

Per-node colors (by index); overridden by a node's own color.


extent?

ts
optional extent?: {
  x?: Range;
  y?: Range;
};

Defined in: charts/sankey.ts:199

Drawing box in data space. Defaults to x [0,1], y [0,1].

x?

ts
optional x?: Range;

y?

ts
optional y?: Range;

labels?

ts
optional labels?: boolean;

Defined in: charts/sankey.ts:209

Draw node name labels. Default true.


ts
links: SankeyLink[];

Defined in: charts/sankey.ts:197


name?

ts
optional name?: string;

Defined in: charts/sankey.ts:206


nodePadding?

ts
optional nodePadding?: number;

Defined in: charts/sankey.ts:201


nodes

ts
nodes: SankeyNode[];

Defined in: charts/sankey.ts:196


nodeWidth?

ts
optional nodeWidth?: number;

Defined in: charts/sankey.ts:200


opacity?

ts
optional opacity?: number;

Defined in: charts/sankey.ts:205

Layer fill opacity (0..1), forwarded to the patches layer. Default 1.


renderType?

ts
optional renderType?: RenderType;

Defined in: charts/sankey.ts:207

MIT licensed. WebGL2 required.