Generic chart¶
A generic chart with full support for ECharts options.
Code¶
Usage¶
Required Packages
import { SiChartComponent } from '@siemens/charts-ng';
@Component({
imports: [SiChartComponent, ...]
})
SiChartComponent API Documentation¶
selector
si-chartInput 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 | Enable custom legend click actions exposed by the selectionChanged event. | |
| dataZoomFilterMode ¶ | FilterMode | 'none' | The data zoom filter mode. (see https://echarts.apache.org/en/option.html#dataZoom-inside.filterMode ) The value 'filter' will cause the lines to be disconnected to the outside of the chart. |
| dataZoomMaxValueSpan ¶ | number | The upper limit of the data zoom slider (see https://echarts.apache.org/en/option.html#dataZoom-slider.maxValueSpan ). | |
| dataZoomMinValueSpan ¶ | number | The lower limit of the data zoom slider (see https://echarts.apache.org/en/option.html#dataZoom-slider.minValueSpan ). | |
| dataZoomRange ¶ | DataZoomRange | Apply a specific zoom range (see https://echarts.apache.org/en/option.html#dataZoom-inside ). | |
| eChartContainerHeight ¶ | (null | string) | The height of the ECharts container as decimal. | |
| externalXAxisFormatter ¶ | (value: any, visibleRange: number) => string | External XAxis Formatter from consumer | |
| externalZoomSlider ¶ | boolean | false | Flag to use external zoom slider |
| maxEntries ¶ | number | 1000 | Maximum number of series data points shown in the chart. |
| 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: '' } | Specify selected legend item. |
| showCustomLegend ¶ | boolean | false | Enable to show a custom legend. The custom legend offers additional features such as, scroll bar to avoid legend and chart overlapping, Left and right alignment of legends based on y-axis, etc and many more. |
| showLegend ¶ | boolean | true | Show Echarts legend |
| subTitle ¶ | string | The subtitle of the chart. | |
| theme ¶ | any | The desired theme to load. | |
| themeCustomization ¶ | any | Used to override specific options of loaded theme . | |
| title ¶ | string | The title of the chart. | |
| 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. Whether zooming inside the chart is possible with mouse. |
| 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 | Event emitted when a chart series is clicked. |
| customLegendMultiLineInfoEvent ¶ | CustomLegendMultiLineInfo[] | Event emitted when custom legend multi-line info changes. |
| dataZoom ¶ | DataZoomEvent | Event emitted when data zoom changes. |
| pointer ¶ | AxisPointerEvent | Event emitted when axis pointer moves. |
| selectionChanged ¶ | any | Event emitted when selection changes e.g. clicking on a legend item. |
| showLegendChange ¶ | boolean | Show Echarts legend |
| timeRangeChange ¶ | number | Emitted when data zoom 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 |
|---|---|---|---|
| startProgressIndication() ¶ | () => void | Show loading indicator. | |
| stopProgressIndication() ¶ | () => void | Hide loading indicator. |
Types Documentation¶
| |||||
|
|
|
|
|
|
|
|
|
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 |
|---|
| imported from echarts |
|---|
| 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.