Skip to main content

SankeyOptions

Options for Sankey diagram

Extends​

Properties​

colorGenerator?​

optional colorGenerator: ColorGenerator

Optional function to call in order to establish the color to be used for each series

Inherited from​

BaseChartOptions.colorGenerator

csvData?​

optional csvData: string

Optional CSV data to load. Each line should be in the format source,target,value.

dataSource?​

optional dataSource: DataSource

Optional data source (of type DataSource, meaning both VisuallyJsModel and Selection are supported) from which to retrieve data to load into the chart.

Inherited from​

BaseChartOptions.dataSource

dataSourceFilter?​

optional dataSourceFilter: ChartModelFilter

When you provide dataSource, you can also provide a filter which accepts or rejects specific nodes/groups in the data source.

Inherited from​

BaseChartOptions.dataSourceFilter

defaultColor?​

optional defaultColor: string

Optional color to use for every series. Overrides any colorGenerator.

Inherited from​

BaseChartOptions.defaultColor

emptyMessage?​

optional emptyMessage: string

Message to display when the chart has no data. Defaults to "No data".

Inherited from​

BaseChartOptions.emptyMessage

height?​

optional height: number

Height for the chart. If omitted, height is computed from the width of the chart's container

Inherited from​

BaseChartOptions.height

interactive?​

optional interactive: boolean

Defaults to true - the charts responds to mouse hover events and highlights edges, nodes and paths.

jsonData?​

optional jsonData: VisuallyJsDefaultJSON

Optional dataset to load.

labelProperty?​

optional labelProperty: string

When using a data source, this property tells the chart which field contains node labels. It defaults to labels. If there is no value provided for the property with this key, the node's ID is used as the label.

labels?​

optional labels: object

Options for the node labels.

backgroundColor?​

optional backgroundColor: string

Optional background color to use for node labels. Defaults to "#FFFFFF56".

font?​

optional font: FontSpec

Optional font spec to use for node labels. Defaults to 12px.

padding?​

optional padding: number

Optional padding to use for node labels. Defaults to 5 pixels.

legend?​

optional legend: boolean | LegendSpec

Either a boolean true/false, indicating the legend should be shown/hidden, or a spec for a legend.

Inherited from​

BaseChartOptions.legend

linkColor?​

optional linkColor: string

Link color to use when linkColorStrategy is 'static'. Defaults to "#444444"

linkColorStrategy?​

optional linkColorStrategy: "source" | "target" | "static" | "source-target"

Strategy for link color: static uses a single color, source-target paints a gradient from source to target, target uses the target node color, source uses the source node color.

nodePadding?​

optional nodePadding: number

Spacing, in pixels, between nodes. Defaults to 10.

nodeWidth?​

optional nodeWidth: number

Width, in pixels, of nodes. Defaults to 15.

padding?​

optional padding: number

Padding to leave around the chart. Defaults to 20 pixels.

resizeObserver?​

optional resizeObserver: boolean

Defaults to true, meaning the chart will redraw when its container element resizes.

Inherited from​

BaseChartOptions.resizeObserver

style?​

optional style: ChartStyleOptions

Styles for legend and grid.

Inherited from​

BaseChartOptions.style

subtitle?​

optional subtitle: SubtitleSpec

Subtitle for the chart.

Inherited from​

BaseChartOptions.subtitle

title?​

optional title: ChartTitleSpec

Title for the chart.

Inherited from​

BaseChartOptions.title

titlePadding?​

optional titlePadding: number

Padding to leave underneath the title

Inherited from​

BaseChartOptions.titlePadding

tooltip?​

optional tooltip: TooltipOptions

Options for a tooltip for the chart.

Inherited from​

BaseChartOptions.tooltip

tooltipSuffix?​

optional tooltipSuffix: string

Optional suffix to append to tooltip labels.

url?​

optional url: string

Optional URL from which to retrieve data to load into the chart

Inherited from​

BaseChartOptions.url

valueProperty?​

optional valueProperty: string

When using a data source, this property tells the chart which field contains edge values. It defaults to value.

width?​

optional width: number

Width for the chart. If omitted, width is computed from the width of the chart's container

Inherited from​

BaseChartOptions.width

zoom?​

optional zoom: object

Optional zoom configuration.

enabled?​

optional enabled: boolean

Whether or not zoom is enabled.

initialValue?​

optional initialValue: number

Initial zoom value. Defaults to 1.

range?​

optional range: [number, number]

Zoom range to support. Defaults to [0.05, 3]

Inherited from​

BaseChartOptions.zoom