SiChartCartesianComponent documentation¶

selector

si-chart-cartesian

Input 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.
series ¶	`CartesianChartSeries`[]		The series for the chart.
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
stacked ¶	`boolean`	`false`	Used to display the chart as a stacked one.
subChartGrids ¶	`SubchartGrid`[]
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.
tooltipFormatter ¶	(`string` \| `TooltipFormatterCallback`<`TopLevelFormatterParams`>)		The content formatter of tooltip's floating layer which supports string template and callback function (see (see https://echarts.apache.org/en/option.html#tooltip.formatter ).
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` .
xAxis ¶	(`ChartXAxis` \| `ChartXAxis`[])		The x axis in cartesian(rectangular) coordinate.
yAxis ¶	(`ChartYAxis` \| `ChartYAxis`[])		The y axis in cartesian(rectangular) coordinate.
zoomInside ¶	`boolean`	`false`	Enables zooming inside the chart with the mouse wheel/touch. Whether zooming inside the chart is possible with mouse.
zoomMode ¶	`boolean`		Enable or disable brush zoom mode
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
addData(...) ¶	(index: `number`, data: `CartesianChartData`) => `void`		Update single chart data entry. Parameters index: `number` data: `CartesianChartData`
addDataMulti(...) ¶	(series: `SeriesUpdate`<`CartesianChartData`>[]) => `void`		Append charts data entries to the end of the series. Parameters series: `SeriesUpdate`<`CartesianChartData`>[]
(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 action: `Payload`
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 seriesName: `string`
getSeriesMarker(...) ¶	(seriesName: `string`) => `string`		Get the series marker by series name. Parameters seriesName: `string`
getSeriesMarkerSvg(...) ¶	(seriesName: `string`) => `string`		Get the series marker svg by series name. Parameters seriesName: `string`
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 isLive: `boolean` = `true` dzToSet: `DataZoomRange`
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 range: `number`
startProgressIndication() ¶	() => `void`		Show loading indicator.
stopProgressIndication() ¶	() => `void`		Hide loading indicator.
toggleSeriesVisibility(...) ¶	(name: `string`, visible: `boolean`) => `void`		Toggle visibility of a series. Parameters name: `string` visible: `boolean`

Types Documentation¶

EChartOption

¶

Interface

Index signature: [ key: string ]: any¶

Properties
dataZoom?: `DataZoomComponentOption`[]¶
grid?: (`GridComponentOption` \| `GridComponentOption`[])¶
legend?: `LegendComponentOption`[]¶
series?: `EChartSeries`¶

FilterMode (`"none"` \| `"filter"` \| `"weakFilter"` \| `"empty"`)¶ Type alias

DataZoomRange

¶

Interface

Properties
end?: `any`¶
endValue?: `any`¶
start?: `any`¶
startValue?: `any`¶
visibleWidth?: `any`¶

SelectedLegendItem

¶

Interface

Properties
legendItemName: `string`¶

CartesianChartSeries (`SiBarSeriesOption` \| `SiLineSeriesOption` \| `SiHeatmapSeriesOption` \| `SiScatterSeriesOption` \| `SiCandlestickSeriesOption` \| `never`)¶ Type alias

SubchartGrid

¶

Interface

Properties
bottom?: (`string` \| `number`)¶
categoryId?: `string`¶
containLabel?: `boolean`¶
height?: (`string` \| `number`)¶
left?: (`string` \| `number`)¶
right?: (`string` \| `number`)¶
top?: (`string` \| `number`)¶

TooltipFormatterCallback ¶ import imported from echarts

TopLevelFormatterParams ¶ import imported from echarts

ChartXAxis

extends ChartAxis¶

Interface

Index signature: [ key: string ]: any¶

Properties
axisLabel?: `any` from `ChartAxis.axisLabel`¶
axisLine?: { onZero: `boolean`, show: `boolean` } from `ChartAxis.axisLine`¶
data?: `AxisData` from `ChartAxis.data`¶
gridIndex?: `number` from `ChartAxis.gridIndex`¶
max?: `number` from `ChartAxis.max`¶
min?: `number` from `ChartAxis.min`¶
name?: `string` from `ChartAxis.name`¶
offset?: `number` from `ChartAxis.offset`¶
position?: `XAxisPosition`¶
show?: `boolean` from `ChartAxis.show`¶
splitLine?: { show: `boolean` } from `ChartAxis.splitLine`¶
splitNumber?: `number` from `ChartAxis.splitNumber`¶
type: `AxisType` from `ChartAxis.type`¶

ChartYAxis

extends ChartAxis¶

Interface

Index signature: [ key: string ]: any¶

Properties
axisLabel?: `any` from `ChartAxis.axisLabel`¶
axisLine?: { onZero: `boolean`, show: `boolean` } from `ChartAxis.axisLine`¶
data?: `AxisData` from `ChartAxis.data`¶
gridIndex?: `number` from `ChartAxis.gridIndex`¶
max?: `number` from `ChartAxis.max`¶
min?: `number` from `ChartAxis.min`¶
name?: `string` from `ChartAxis.name`¶
offset?: `number` from `ChartAxis.offset`¶
position?: `YAxisPosition`¶
scale?: `boolean`¶
show?: `boolean` from `ChartAxis.show`¶
splitLine?: { show: `boolean` } from `ChartAxis.splitLine`¶
splitNumber?: `number` from `ChartAxis.splitNumber`¶
type: `AxisType` from `ChartAxis.type`¶

GridRectCoordinate

¶

Interface

Properties
containerHeight: `number`¶
containerWidth: `number`¶
height: `number`¶
width: `number`¶
x: `number`¶
y: `number`¶

LegendItem

¶

Interface

Properties
color?: `string`¶
dataIndex: `number`¶
itemName: `string`¶
selected?: `boolean`¶

CustomLegendMultiLineInfo

¶

Interface

Properties
customLegendId: `number`¶
isCustomLegendMultilined: `boolean`¶

DataZoomEvent

¶

Interface

Properties
autoZoomUpdate?: `boolean`¶
rangeEnd: `any`¶
rangeStart: `any`¶
rangeType: `AxisType`¶
requested?: `DataZoomRange`¶
source?: `string`¶
width?: `number`¶

AxisPointerEvent

¶

Interface

Properties
dataIndex?: `number`¶
seriesIndex?: `number`¶

SiBarSeriesOption (`BarSeriesOption` & `SiSeriesOption`)¶ Type alias

SiLineSeriesOption

extends LineSeriesOption, SiSeriesOption¶

Interface

Properties
If enable animation animation?: `boolean` from `LineSeriesOption.animation`¶
Delay of initialize animation Can be a callback to specify duration of each element animationDelay?: (`number` \| `AnimationDelayCallback`) from `LineSeriesOption.animationDelay`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDelayUpdate?: (`number` \| `AnimationDelayCallback`) from `LineSeriesOption.animationDelayUpdate`¶
Duration of initialize animation. Can be a callback to specify duration of each element animationDuration?: (`number` \| `AnimationDurationCallback`) from `LineSeriesOption.animationDuration`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDurationUpdate?: (`number` \| `AnimationDurationCallback`) from `LineSeriesOption.animationDurationUpdate`¶
Easing of initialize animation animationEasing?: `AnimationEasing` from `LineSeriesOption.animationEasing`¶
Easing of data update animation. animationEasingUpdate?: `AnimationEasing` from `LineSeriesOption.animationEasingUpdate`¶
Disable animation when the number of elements exceeds the threshold animationThreshold?: `number` from `LineSeriesOption.animationThreshold`¶
area?: `boolean`¶
areaStyle?: (`AreaStyleOption`<`ZRColor`> & { origin: (`number` \| `"auto"` \| `"end"` \| `"start"`) }) from `LineSeriesOption.areaStyle`¶
blendMode?: `string` from `LineSeriesOption.blendMode`¶
Blur states. blur?: (`LineStateOption`<`CallbackDataParams`> & { areaStyle: `AreaStyleOption`<`ZRColor`>, lineStyle: `LineStyleOption`<`ZRColor`> }) from `LineSeriesOption.blur`¶
clip?: `boolean` from `LineSeriesOption.clip`¶
color?: (`ZRColor` \| `ZRColor`[]) from `LineSeriesOption.color`¶
colorBy?: `ColorBy` from `LineSeriesOption.colorBy`¶
colorLayer?: `ZRColor`[][] from `LineSeriesOption.colorLayer`¶
connectNulls?: `boolean` from `LineSeriesOption.connectNulls`¶
coord?: `CoordinateSystemDataCoord` from `LineSeriesOption.coord`¶
coordinateSystem?: (`"polar"` \| `"cartesian2d"`) from `LineSeriesOption.coordinateSystem`¶
coordinateSystemUsage?: `CoordinateSystemUsageOption` from `LineSeriesOption.coordinateSystemUsage`¶
Cursor when mouse on the elements cursor?: `string` from `LineSeriesOption.cursor`¶
customLegendToolTip?: `string` from `customLegendToolTip`¶
data?: (`LineDataValue` \| `LineDataItemOption`)[] from `LineSeriesOption.data`¶
groupId of data. can be used for doing drilldown / up animation It will be ignored if: - groupId is specified in each data - encode.itemGroupId is given. dataGroupId?: `OptionId` from `LineSeriesOption.dataGroupId`¶
datasetId?: (`string` \| `number`) from `LineSeriesOption.datasetId`¶
datasetIndex?: `number` from `LineSeriesOption.datasetIndex`¶
dimensions?: `DimensionDefinitionLoose`[] from `LineSeriesOption.dimensions`¶
displayName?: `string` from `displayName`¶
Emphasis states emphasis?: (`LineStateOption`<`CallbackDataParams`> & { focus: `DefaultEmphasisFocus`, scale: (`number` \| `boolean`) } & { areaStyle: `AreaStyleOption`<`ZRColor`>, lineStyle: (`Omit`<`LineStyleOption`<`ZRColor`>, `"width"`> & { width: (`number` \| `"bolder"`) }) } & { blurScope: `BlurScope`, disabled: `boolean` }) from `LineSeriesOption.emphasis`¶
encode?: `OptionEncode` from `LineSeriesOption.encode`¶
endLabel?: `LineEndLabelOption` from `LineSeriesOption.endLabel`¶
hoverLayerThreshold?: `number` from `LineSeriesOption.hoverLayerThreshold`¶
id?: `OptionId` from `LineSeriesOption.id`¶
itemStyle?: `ItemStyleOption`<`CallbackDataParams`> from `LineSeriesOption.itemStyle`¶
label?: `SeriesLabelOption`<`CallbackDataParams`, { positionExtra: `never` }> from `LineSeriesOption.label`¶
Overall label layout option in label layout stage. labelLayout?: (`LabelLayoutOption` \| `LabelLayoutOptionCallback`) from `LineSeriesOption.labelLayout`¶
labelLine?: `LabelLineOption` from `LineSeriesOption.labelLine`¶
legendHoverLink?: `boolean` from `LineSeriesOption.legendHoverLink`¶
lineStyle?: `LineStyleOption`<`ZRColor`> from `LineSeriesOption.lineStyle`¶
mainType?: `"series"` from `LineSeriesOption.mainType`¶
markArea?: `MarkAreaComponentOption` from `LineSeriesOption.markArea`¶
markLine?: `MarkLineComponentOption` from `LineSeriesOption.markLine`¶
markPoint?: `MarkPointComponentOption` from `LineSeriesOption.markPoint`¶
name?: `OptionName` from `LineSeriesOption.name`¶
polarId?: `string` from `LineSeriesOption.polarId`¶
polarIndex?: `number` from `LineSeriesOption.polarIndex`¶
Configurations about progressive rendering progressive?: (`number` \| `false`) from `LineSeriesOption.progressive`¶
progressiveChunkMode?: `"mod"` from `LineSeriesOption.progressiveChunkMode`¶
progressiveThreshold?: `number` from `LineSeriesOption.progressiveThreshold`¶
sampling?: (`"max"` \| `"none"` \| `"min"` \| `"sum"` \| `"average"` \| `"minmax"` \| `"lttb"` \| `SamplingFunc`) from `LineSeriesOption.sampling`¶
Select states select?: (`LineStateOption`<`CallbackDataParams`> & { disabled: `boolean` }) from `LineSeriesOption.select`¶
Map of selected data key is name or index of data. selectedMap?: (`"all"` \| `Dictionary`<`boolean`>) from `LineSeriesOption.selectedMap`¶
selectedMode?: (`boolean` \| `"multiple"` \| `"single"` \| `"series"`) from `LineSeriesOption.selectedMode`¶
When dataset is used, seriesLayoutBy specifies whether the column or the row of dataset is mapped to the series namely, the series is "layout" on columns or rows seriesLayoutBy?: (`"column"` \| `"row"`) from `LineSeriesOption.seriesLayoutBy` = `'column'`¶
showAllSymbol?: (`boolean` \| `"auto"`) from `LineSeriesOption.showAllSymbol`¶
showSymbol?: `boolean` from `LineSeriesOption.showSymbol`¶
silent?: `boolean` from `LineSeriesOption.silent`¶
smooth?: (`number` \| `boolean`) from `LineSeriesOption.smooth`¶
smoothMonotone?: (`"none"` \| `"x"` \| `"y"`) from `LineSeriesOption.smoothMonotone`¶
sourceHeader?: `OptionSourceHeader` from `LineSeriesOption.sourceHeader`¶
stack?: `string` from `LineSeriesOption.stack`¶
stackOrder?: (`"seriesAsc"` \| `"seriesDesc"`) from `LineSeriesOption.stackOrder`¶
stackStrategy?: (`"all"` \| `"samesign"` \| `"positive"` \| `"negative"`) from `LineSeriesOption.stackStrategy`¶
Animation config for state transition. stateAnimation?: `AnimationOption$1` from `LineSeriesOption.stateAnimation`¶
step?: (`false` \| `"end"` \| `"start"` \| `"middle"`) from `LineSeriesOption.step`¶
type of symbol, like `cirlce` , `rect` , or custom path and image. symbol?: (`string` \| `SymbolCallback`<`CallbackDataParams`>) from `LineSeriesOption.symbol`¶
symbolKeepAspect?: `boolean` from `LineSeriesOption.symbolKeepAspect`¶
symbolOffset?: (`string` \| `number` \| (`string` \| `number`)[] \| `SymbolOffsetCallback`<`CallbackDataParams`>) from `LineSeriesOption.symbolOffset`¶
symbolRotate?: (`number` \| `SymbolRotateCallback`<`CallbackDataParams`>) from `LineSeriesOption.symbolRotate`¶
Size of symbol. symbolSize?: (`number` \| `number`[] \| `SymbolSizeCallback`<`CallbackDataParams`>) from `LineSeriesOption.symbolSize`¶
tooltip?: `SeriesTooltipOption` from `LineSeriesOption.tooltip`¶
triggerLineEvent?: `boolean` from `LineSeriesOption.triggerLineEvent`¶
type?: `"line"` from `LineSeriesOption.type`¶
If enabled universal transition cross series. Example: `universalTransition: true universalTransition: { enabled: true }` universalTransition?: (`boolean` \| `UniversalTransitionOption`) from `LineSeriesOption.universalTransition`¶
visible?: `boolean` from `visible`¶
xAxisId?: `string` from `LineSeriesOption.xAxisId`¶
xAxisIndex?: `number` from `LineSeriesOption.xAxisIndex`¶
yAxisId?: `string` from `LineSeriesOption.yAxisId`¶
yAxisIndex?: `number` from `LineSeriesOption.yAxisIndex`¶
z?: `number` from `LineSeriesOption.z`¶
zlevel?: `number` from `LineSeriesOption.zlevel`¶

SiHeatmapSeriesOption (`HeatmapSeriesOption` & `SiSeriesOption`)¶ Type alias

SiScatterSeriesOption (`ScatterSeriesOption` & `SiSeriesOption`)¶ Type alias

SiCandlestickSeriesOption (`CandlestickSeriesOption` & `SiSeriesOption`)¶ Type alias

DataZoomComponentOption (`SliderDataZoomOption` \| `InsideDataZoomOption`)¶ Type alias

GridComponentOption

extends ComponentOption, BoxLayoutOptionMixin, ShadowOptionMixin¶

Interface

Properties
backgroundColor?: `ZRColor`¶
borderColor?: `ZRColor`¶
borderWidth?: `number`¶
bottom?: `PositionSizeOption` from `BoxLayoutOptionMixin.bottom`¶
Deprecated: Use `grid.outerBounds` instead. Whether grid size contains axis labels. This approach estimates the size by sample labels. It works for most case but it does not strictly contain all labels in some cases. ~~containLabel~~?: `boolean`¶
coord?: `CoordinateSystemDataCoord` from `ComponentOption.coord`¶
coordinateSystem?: `string` from `ComponentOption.coordinateSystem`¶
coordinateSystemUsage?: `CoordinateSystemUsageOption` from `ComponentOption.coordinateSystemUsage`¶
height?: `PositionSizeOption` from `BoxLayoutOptionMixin.height`¶
id?: `OptionId` from `ComponentOption.id`¶
left?: `PositionSizeOption` from `BoxLayoutOptionMixin.left`¶
mainType?: `"grid"`¶
name?: `OptionName` from `ComponentOption.name`¶
{left, right, top, bottom, width, height}: Define a outerBounds rect, based on: - the canvas by default. - or the `dataToLayout` result if a `boxCoordinateSystem` is specified. outerBounds?: `BoxLayoutOptionMixin`¶
outerBoundsClampHeight?: (`string` \| `number`)¶
Available only when `outerBoundsMode` is not 'none'. Offer a constraint to not to shrink the grid rect causing smaller that width/height. A string means percent, like '30%', based on the original rect size determined by `grid.top/right/bottom/left/width/height` . outerBoundsClampWidth?: (`string` \| `number`)¶
- 'all': Default. Contains the cartesian rect and axis labels and axis name. - 'axisLabel': Contains the cartesian rect and axis labels. This effect differs slightly from the previous option `containLabel` but more precise. - 'auto'/null/undefined: Default. be 'axisLabel' if `containLabel:true` , otherwise 'all'. outerBoundsContain?: (`"all"` \| `"auto"` \| `"axisLabel"` \| `NullUndefined$1`)¶
Define a constrains rect. Axis lines is firstly laid out based on the rect defined by `grid.left/right/top/bottom/width/height` . (for axis line alignment requirements between multiple grids) But if axisLabel and/or axisName overflow the outerBounds, shrink the layout to avoid that overflow. Options: - 'none': outerBounds is infinity. - 'same': outerBounds is the same as the layout rect defined by `grid.left/right/top/bottom/width/height` . - 'auto'/null/undefined: Default. Use `outerBounds` , or 'same' if `containLabel:true` . Note: `grid.containLabel` is equivalent to `{outerBoundsMode: 'same', outerBoundsContain: 'axisLabel'}` . outerBoundsMode?: (`"auto"` \| `"none"` \| `"same"` \| `NullUndefined$1`)¶
right?: `PositionSizeOption` from `BoxLayoutOptionMixin.right`¶
shadowBlur?: `number` from `ShadowOptionMixin.shadowBlur`¶
shadowColor?: `string` from `ShadowOptionMixin.shadowColor`¶
shadowOffsetX?: `number` from `ShadowOptionMixin.shadowOffsetX`¶
shadowOffsetY?: `number` from `ShadowOptionMixin.shadowOffsetY`¶
show?: `boolean`¶
tooltip?: `any`¶
top?: `PositionSizeOption` from `BoxLayoutOptionMixin.top`¶
type?: `string` from `ComponentOption.type`¶
width?: `PositionSizeOption` from `BoxLayoutOptionMixin.width`¶
z?: `number` from `ComponentOption.z`¶
zlevel?: `number` from `ComponentOption.zlevel`¶

LegendComponentOption (`LegendOption` \| `ScrollableLegendOption`)¶ Type alias

EChartSeries `EChartSeriesOption`[]¶ Type alias

BarSeriesOption (`BarSeriesOption$1` & `SeriesInjectedOption`)¶ Type alias

SiSeriesOption

¶

Interface

Properties
customLegendToolTip?: `string`¶
displayName?: `string`¶
visible?: `boolean`¶

LineSeriesOption (`LineSeriesOption` & `SeriesInjectedOption`)¶ Type alias

HeatmapSeriesOption (`HeatmapSeriesOption` & `SeriesInjectedOption`)¶ Type alias

ScatterSeriesOption (`ScatterSeriesOption` & `SeriesInjectedOption`)¶ Type alias

CandlestickSeriesOption (`CandlestickSeriesOption` & `SeriesInjectedOption`)¶ Type alias

AxisData (`string` \| `number` \| `any`)[]¶ Type alias

XAxisPosition (`"top"` \| `"bottom"`)¶ Type alias

AxisType (`"value"` \| `"category"` \| `"time"` \| `"log"`)¶ Type alias

YAxisPosition (`"left"` \| `"right"`)¶ Type alias

CartesianChartData `NonNullable`<`CartesianDataNullable`>¶ Type alias

SeriesUpdate

<SeriesType>¶

Interface

Properties
data: `SeriesType`¶
index: `number`¶

Payload

extends PayloadItem¶

Interface

Index signature: [ other: string ]: any¶

Properties
animation?: `PayloadAnimationPart` from `PayloadItem.animation`¶
batch?: `PayloadItem`[]¶
escapeConnect?: `boolean`¶
excludeSeriesId?: (`OptionId` \| `OptionId`[]) from `PayloadItem.excludeSeriesId`¶
type: `string`¶

SliderDataZoomOption ¶ import imported from echarts

InsideDataZoomOption ¶ import imported from echarts

ComponentOption ¶ import imported from echarts

BoxLayoutOptionMixin ¶ import imported from echarts

ShadowOptionMixin ¶ import imported from echarts

LegendOption ¶ import imported from echarts

ScrollableLegendOption ¶ import imported from echarts

EChartSeriesOption (`BarSeriesOption` \| `CandlestickSeriesOption` \| `CustomSeriesOption` \| `GaugeSeriesOption` \| `HeatmapSeriesOption` \| `LineSeriesOption` \| `PieSeriesOption` \| `ScatterSeriesOption` \| `SankeySeriesOption` \| `SunburstSeriesOption` \| `never`)¶ Type alias

BarSeriesOption$1 ¶ import imported from echarts

SeriesInjectedOption ¶ import imported from echarts

AnimationDelayCallback ¶ import imported from echarts

AnimationDurationCallback ¶ import imported from echarts

AnimationEasing ¶ import imported from echarts

AreaStyleOption ¶ import imported from echarts

ZRColor ¶ import imported from echarts

LineStateOption ¶ import imported from echarts

CallbackDataParams ¶ import imported from echarts

ColorBy ¶ import imported from echarts

CoordinateSystemDataCoord ¶ import imported from echarts

CoordinateSystemUsageOption ¶ import imported from echarts

LineDataValue ¶ import imported from echarts

LineDataItemOption ¶ import imported from echarts

OptionId ¶ import imported from echarts

DimensionDefinitionLoose ¶ import imported from echarts

OptionEncode ¶ import imported from echarts

LineEndLabelOption ¶ import imported from echarts

ItemStyleOption ¶ import imported from echarts

SeriesLabelOption ¶ import imported from echarts

LabelLayoutOption ¶ import imported from echarts

LabelLayoutOptionCallback ¶ import imported from echarts

LabelLineOption ¶ import imported from echarts

LineStyleOption ¶ import imported from echarts

MarkAreaComponentOption

extends MarkerOption, MarkAreaStateOption, StatesOptionMixin<MarkAreaStateOption, StatesMixinBase>¶

Interface

Properties
If enable animation animation?: `boolean` from `MarkerOption.animation`¶
Delay of initialize animation Can be a callback to specify duration of each element animationDelay?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelay`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDelayUpdate?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelayUpdate`¶
Duration of initialize animation. Can be a callback to specify duration of each element animationDuration?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDuration`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDurationUpdate?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDurationUpdate`¶
Easing of initialize animation animationEasing?: `AnimationEasing` from `MarkerOption.animationEasing`¶
Easing of data update animation. animationEasingUpdate?: `AnimationEasing` from `MarkerOption.animationEasingUpdate`¶
Disable animation when the number of elements exceeds the threshold animationThreshold?: `number` from `MarkerOption.animationThreshold`¶
Blur states. blur?: `MarkAreaStateOption` from `StatesOptionMixin.blur`¶
coord?: `CoordinateSystemDataCoord` from `MarkerOption.coord`¶
coordinateSystem?: `string` from `MarkerOption.coordinateSystem`¶
coordinateSystemUsage?: `CoordinateSystemUsageOption` from `MarkerOption.coordinateSystemUsage`¶
data?: (`MarkArea1DDataItemOption` \| `MarkArea2DDataItemOption`)[]¶
Emphasis states emphasis?: (`MarkAreaStateOption` & { blurScope: `BlurScope`, disabled: `boolean` }) from `StatesOptionMixin.emphasis`¶
id?: `OptionId` from `MarkerOption.id`¶
itemStyle?: `ItemStyleOption`<`never`> from `MarkAreaStateOption.itemStyle`¶
label?: `SeriesLabelOption`<`CallbackDataParams`, { positionExtra: `never` }> from `MarkAreaStateOption.label`¶
mainType?: `"markArea"`¶
name?: `OptionName` from `MarkerOption.name`¶
precision?: `number`¶
Select states select?: (`MarkAreaStateOption` & { disabled: `boolean` }) from `StatesOptionMixin.select`¶
silent?: `boolean` from `MarkerOption.silent`¶
tooltip?: (`CommonTooltipOption`<`unknown`> & { trigger: (`boolean` \| `"none"` \| `"item"` \| `"axis"`) }) from `MarkerOption.tooltip`¶
type?: `string` from `MarkerOption.type`¶
z?: `number` from `MarkerOption.z`¶
z2?: `number` from `MarkAreaStateOption.z2`¶
zlevel?: `number` from `MarkerOption.zlevel`¶

MarkLineComponentOption

extends MarkerOption, MarkLineStateOption, StatesOptionMixin<MarkLineStateOption, StatesMixinBase>¶

Interface

Properties
If enable animation animation?: `boolean` from `MarkerOption.animation`¶
Delay of initialize animation Can be a callback to specify duration of each element animationDelay?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelay`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDelayUpdate?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelayUpdate`¶
Duration of initialize animation. Can be a callback to specify duration of each element animationDuration?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDuration`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDurationUpdate?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDurationUpdate`¶
Easing of initialize animation animationEasing?: `AnimationEasing` from `MarkerOption.animationEasing`¶
Easing of data update animation. animationEasingUpdate?: `AnimationEasing` from `MarkerOption.animationEasingUpdate`¶
Disable animation when the number of elements exceeds the threshold animationThreshold?: `number` from `MarkerOption.animationThreshold`¶
Blur states. blur?: `MarkLineStateOption` from `StatesOptionMixin.blur`¶
coord?: `CoordinateSystemDataCoord` from `MarkerOption.coord`¶
coordinateSystem?: `string` from `MarkerOption.coordinateSystem`¶
coordinateSystemUsage?: `CoordinateSystemUsageOption` from `MarkerOption.coordinateSystemUsage`¶
data?: (`MarkLine1DDataItemOption` \| `MarkLine2DDataItemOption`)[]¶
Emphasis states emphasis?: (`MarkLineStateOption` & { blurScope: `BlurScope`, disabled: `boolean` }) from `StatesOptionMixin.emphasis`¶
id?: `OptionId` from `MarkerOption.id`¶
itemStyle for symbol itemStyle?: `ItemStyleOption`<`never`> from `MarkLineStateOption.itemStyle`¶
label?: `SeriesLineLabelOption` from `MarkLineStateOption.label`¶
lineStyle?: `LineStyleOption`<`ZRColor`> from `MarkLineStateOption.lineStyle`¶
mainType?: `"markLine"`¶
name?: `OptionName` from `MarkerOption.name`¶
Precision used on statistic method precision?: `number`¶
Select states select?: (`MarkLineStateOption` & { disabled: `boolean` }) from `StatesOptionMixin.select`¶
silent?: `boolean` from `MarkerOption.silent`¶
symbol?: (`string` \| `string`[])¶
symbolOffset?: (`string` \| `number` \| (`string` \| `number`)[] \| (`string` \| `number`)[][])¶
symbolRotate?: (`number` \| `number`[])¶
symbolSize?: (`number` \| `number`[])¶
tooltip?: (`CommonTooltipOption`<`unknown`> & { trigger: (`boolean` \| `"none"` \| `"item"` \| `"axis"`) }) from `MarkerOption.tooltip`¶
type?: `string` from `MarkerOption.type`¶
z?: `number` from `MarkerOption.z`¶
z2?: `number` from `MarkLineStateOption.z2`¶
zlevel?: `number` from `MarkerOption.zlevel`¶

MarkPointComponentOption

extends MarkerOption, SymbolOptionMixin<CallbackDataParams>, StatesOptionMixin<MarkPointStateOption, StatesMixinBase>, MarkPointStateOption¶

Interface

Properties
If enable animation animation?: `boolean` from `MarkerOption.animation`¶
Delay of initialize animation Can be a callback to specify duration of each element animationDelay?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelay`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDelayUpdate?: (`number` \| `AnimationDelayCallback`) from `MarkerOption.animationDelayUpdate`¶
Duration of initialize animation. Can be a callback to specify duration of each element animationDuration?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDuration`¶
Delay of data update animation. Can be a callback to specify duration of each element animationDurationUpdate?: (`number` \| `AnimationDurationCallback`) from `MarkerOption.animationDurationUpdate`¶
Easing of initialize animation animationEasing?: `AnimationEasing` from `MarkerOption.animationEasing`¶
Easing of data update animation. animationEasingUpdate?: `AnimationEasing` from `MarkerOption.animationEasingUpdate`¶
Disable animation when the number of elements exceeds the threshold animationThreshold?: `number` from `MarkerOption.animationThreshold`¶
Blur states. blur?: `MarkPointStateOption` from `StatesOptionMixin.blur`¶
coord?: `CoordinateSystemDataCoord` from `MarkerOption.coord`¶
coordinateSystem?: `string` from `MarkerOption.coordinateSystem`¶
coordinateSystemUsage?: `CoordinateSystemUsageOption` from `MarkerOption.coordinateSystemUsage`¶
data?: `MarkPointDataItemOption`[]¶
Emphasis states emphasis?: (`MarkPointStateOption` & { blurScope: `BlurScope`, disabled: `boolean` }) from `StatesOptionMixin.emphasis`¶
id?: `OptionId` from `MarkerOption.id`¶
itemStyle?: `ItemStyleOption`<`never`> from `MarkPointStateOption.itemStyle`¶
label?: `SeriesLabelOption`<`CallbackDataParams`, { positionExtra: `never` }> from `MarkPointStateOption.label`¶
mainType?: `"markPoint"`¶
name?: `OptionName` from `MarkerOption.name`¶
precision?: `number`¶
Select states select?: (`MarkPointStateOption` & { disabled: `boolean` }) from `StatesOptionMixin.select`¶
silent?: `boolean` from `MarkerOption.silent`¶
type of symbol, like `cirlce` , `rect` , or custom path and image. symbol?: (`string` \| `SymbolCallback`<`CallbackDataParams`>) from `SymbolOptionMixin.symbol`¶
symbolKeepAspect?: `boolean` from `SymbolOptionMixin.symbolKeepAspect`¶
symbolOffset?: (`string` \| `number` \| (`string` \| `number`)[] \| `SymbolOffsetCallback`<`CallbackDataParams`>) from `SymbolOptionMixin.symbolOffset`¶
symbolRotate?: (`number` \| `SymbolRotateCallback`<`CallbackDataParams`>) from `SymbolOptionMixin.symbolRotate`¶
Size of symbol. symbolSize?: (`number` \| `number`[] \| `SymbolSizeCallback`<`CallbackDataParams`>) from `SymbolOptionMixin.symbolSize`¶
tooltip?: (`CommonTooltipOption`<`unknown`> & { trigger: (`boolean` \| `"none"` \| `"item"` \| `"axis"`) }) from `MarkerOption.tooltip`¶
type?: `string` from `MarkerOption.type`¶
z?: `number` from `MarkerOption.z`¶
z2?: `number` from `MarkPointStateOption.z2`¶
zlevel?: `number` from `MarkerOption.zlevel`¶

OptionName ¶ import imported from echarts

SamplingFunc ¶ import imported from echarts

Dictionary ¶ import imported from echarts

OptionSourceHeader ¶ import imported from echarts

AnimationOption$1 ¶ import imported from echarts

SymbolCallback ¶ import imported from echarts

SymbolOffsetCallback ¶ import imported from echarts

SymbolRotateCallback ¶ import imported from echarts

SymbolSizeCallback ¶ import imported from echarts

SeriesTooltipOption ¶ import imported from echarts

UniversalTransitionOption ¶ import imported from echarts

LineSeriesOption ¶ import imported from echarts

HeatmapSeriesOption ¶ import imported from echarts

ScatterSeriesOption ¶ import imported from echarts

CandlestickSeriesOption ¶ import imported from echarts

CartesianDataNullable (`any`[] \| `any`[] \| `any`[] \| `any`[] \| `any`[] \| `never`)¶ Type alias

PayloadItem ¶ import imported from echarts

PositionSizeOption ¶ import imported from echarts

NullUndefined$1 ¶ import imported from echarts

CustomSeriesOption (`CustomSeriesOption$1` & `SeriesInjectedOption`)¶ Type alias

GaugeSeriesOption (`GaugeSeriesOption` & `SeriesInjectedOption`)¶ Type alias

PieSeriesOption (`PieSeriesOption` & `SeriesInjectedOption`)¶ Type alias

SankeySeriesOption (`SankeySeriesOption` & `SeriesInjectedOption`)¶ Type alias

SunburstSeriesOption (`SunburstSeriesOption` & `SeriesInjectedOption`)¶ Type alias

MarkerOption ¶ import imported from echarts

MarkAreaStateOption ¶ import imported from echarts

StatesOptionMixin ¶ import imported from echarts

StatesMixinBase ¶ import imported from echarts

MarkLineStateOption ¶ import imported from echarts

SymbolOptionMixin ¶ import imported from echarts

MarkPointStateOption ¶ import imported from echarts

PayloadAnimationPart ¶ import imported from echarts

CustomSeriesOption$1 ¶ import imported from echarts

GaugeSeriesOption ¶ import imported from echarts

PieSeriesOption ¶ import imported from echarts

SankeySeriesOption ¶ import imported from echarts

SunburstSeriesOption ¶ import imported from echarts

DefaultEmphasisFocus ¶ import imported from echarts

BlurScope ¶ import imported from echarts

MarkArea1DDataItemOption ¶ import imported from echarts

MarkArea2DDataItemOption ¶ import imported from echarts

CommonTooltipOption ¶ import imported from echarts

MarkLine1DDataItemOption ¶ import imported from echarts

MarkLine2DDataItemOption ¶ import imported from echarts

SeriesLineLabelOption ¶ import imported from echarts

MarkPointDataItemOption ¶ import imported from echarts

Except where otherwise noted, content on this site is licensed under MIT License.