SiChartSankeyComponent documentation¶
selector
si-chart-sankeyInput Properties¶
| Name | Type | Default | Description |
|---|---|---|---|
| additionalOptions ¶ | EChartOption | Used to override specific properties set in options . | |
| autoZoomSeriesIndex ¶ | number | -1 | No auto dataZoom update) by default. Use together with visibleEntries . |
| axisPointer ¶ | (undefined | string | boolean) | false | Used to display axisPointer line either by click or mouse-move. |
| customLegendAction ¶ | boolean | ||
| dataZoomFilterMode ¶ | FilterMode | 'none' | |
| dataZoomMaxValueSpan ¶ | number | ||
| dataZoomMinValueSpan ¶ | number | ||
| dataZoomRange ¶ | DataZoomRange | ||
| eChartContainerHeight ¶ | (null | string) | ||
| externalXAxisFormatter ¶ | (value: any, visibleRange: number) => string | External XAxis Formatter from consumer | |
| externalZoomSlider ¶ | boolean | false | Flag to use external zoom slider |
| maxEntries ¶ | number | 1000 | |
| options ¶ | EChartOption | See [ECharts 5.x Documentation] https://echarts.apache.org/en/option.html for all available options. | |
| palette ¶ | string | undefined | The name of the color palette (if any) of the loaded theme . |
| renderer ¶ | ("canvas" | "svg") | 'canvas' | the renderer to use: canvas or svg |
| selectedItem ¶ | SelectedLegendItem | { legendItemName: '' } | |
| series ¶ | SankeySeriesOption | ||
| showCustomLegend ¶ | boolean | false | |
| showLegend ¶ | boolean | true | |
| subTitle ¶ | string | ||
| theme ¶ | any | The desired theme to load. | |
| themeCustomization ¶ | any | Used to override specific options of loaded theme . | |
| title ¶ | string | ||
| toolTip ¶ | boolean | false | |
| visibleEntries ¶ | number | -1 | No auto dataZoom update) by default. Use together with autoZoomSeriesIndex . |
| visibleRange ¶ | number | -1 | No auto dataZoom update) by default. Use together with autoZoomSeriesIndex . |
| zoomInside ¶ | boolean | false | Enables zooming inside the chart with the mouse wheel/touch. |
| zoomSlider ¶ | boolean | false | Enables the zoom slider below the chart. |
| zoomSliderBrush ¶ | boolean | true | enable brush mode for zoom slider |
| zoomSliderRealtime ¶ | boolean | true | realtime update mode for zoom slider |
| zoomSliderShadow ¶ | boolean | true | Shows data shadow in dataZoom slider, use together with zoomSlider . |
showTimeRangeBar ¶ | boolean | false | If true, add consumer-provided time range bar. Use together with zoomSlider .Deprecated: The input will be removed in future versions as the time range bar slot is deprecated. |
Output Properties¶
| Name | Type | Description |
|---|---|---|
| chartGridResized ¶ | GridRectCoordinate | Event emitted when chart grid is resized. |
| chartSeriesClick ¶ | LegendItem | |
| customLegendMultiLineInfoEvent ¶ | CustomLegendMultiLineInfo[] | |
| dataZoom ¶ | DataZoomEvent | Event emitted when data zoom changes. |
| pointer ¶ | AxisPointerEvent | Event emitted when axis pointer moves. |
| selectionChanged ¶ | any | |
| showLegendChange ¶ | boolean | |
| timeRangeChange ¶ | number | Emitted when datazoom changes, indicating the time range in milliseconds, 0 for full range |
| visibleEntriesChange ¶ | number | No auto dataZoom update) by default. Use together with autoZoomSeriesIndex . |
| visibleRangeChange ¶ | number | No auto dataZoom update) by default. Use together with autoZoomSeriesIndex . |
Attributes and Methods¶
| Name | Type | Default | Description |
|---|---|---|---|
| (readonly) chartContainerWrapper ¶ | Signal<ElementRef<any>> | viewChild.required<ElementRef>('chartContainerWrapper') | reference to the wrapper container. Used for setting scroll position, etc. |
| dispatchEChartAction(...) ¶ | (action: Payload) => void | Send action to echart. See https://echarts.apache.org/en/api.html#action Parameters
| |
| getOptionNoClone() ¶ | () => any | returns the current EChart options, w/o cloning anything. Be very careful not to change anything in the data structure in it. | |
| getSeriesColorBySeriesName(...) ¶ | (seriesName: string) => (undefined | string) | Get color by series name. Parameters
| |
| getVisibleRange() ¶ | () => (undefined | DataZoomEvent) | Get current data zoom range. | |
| refreshSeries(...) ¶ | (isLive: boolean = true, dzToSet: DataZoomRange) => void | Re-render the chart series data. This method should be called on series data changes. Parameters
| |
| resetChart() ¶ | () => void | Re-render the whole chart. | |
| resize() ¶ | () => void | Allow consuming applications to re-draw chart on window resizes. | |
| setTimeRange(...) ¶ | (range: number) => void | Set the data zoom range for the chart in milliseconds. As an example one hour is the value 3600000. Parameters
| |
| startProgressIndication() ¶ | () => void | Show loading indicator. | |
| stopProgressIndication() ¶ | () => void | Hide loading indicator. | |
| toggleSeriesVisibility(...) ¶ | (name: string, visible: boolean) => void | Toggle visibility of a series. Parameters |
Types Documentation¶
| |||||
|
|
|
|
|
|
|
|
import imported from echarts |
|---|
import imported from echarts |
|---|
|
| Copyright (c) Siemens 2016 - 2025 SPDX-License-Identifier: MIT |
|---|
| ||||||
|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
import imported from echarts |
|---|
Except where otherwise noted, content on this site is licensed under MIT License.