Skip to main content

SankeyChartComponent

A sankey chart. Data can be sourced from a url, a JS object or CSV data, or - if you want to use the chart as part of a dashboard - from the current model provisioned by the VisuallyJsService.

Implements​

  • AfterViewInit
  • OnDestroy
  • OnChanges

Methods​

ngOnChanges()​

ngOnChanges(changes): void

A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

Parameters​

changes​

SimpleChanges

The changed properties.

Returns​

void

Implementation of​

OnChanges.ngOnChanges

ngOnDestroy()​

ngOnDestroy(): void

A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns​

void

Implementation of​

OnDestroy.ngOnDestroy

Properties​

csvData​

csvData: InputSignal<string>

Optional data to load into the chart. This is reactive and can be updated dynamically. (in CSV format)

Input​

interactive?​

optional interactive: boolean

Whether the chart is interactive.

Input​

jsonData​

jsonData: InputSignal<VisuallyJsDefaultJSON>

Optional data to load into the chart. This is reactive and can be updated dynamically. (in VisuallyJs default json format)

Input​

options​

options: SankeyChartComponentOptions

Options for the chart. This is reactive and can be updated dynamically.

Input​

pivot?​

optional pivot: string

Optional property to pivot the sankey chart on.

Input​

url​

url: InputSignal<string>

Optional URL for data to load into the chart. This is reactive and can be updated dynamically.

Input​

useModel?​

optional useModel: boolean

If true, the component attaches to a model provided by the VisuallyJsService. Defaults to false.

Input​