Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EChartOption

Hierarchy

Index

Properties

Optional actions

actions?: ChartAction[]

ChartActions

Optional angleAxis

angleAxis?: object

The angle axis in Polar Coordinate.

see

https://echarts.apache.org/en/option.html#angleAxis

Optional animation

animation?: boolean

Whether to enable animation.

see

https://echarts.apache.org/en/option.html#animation

Optional animationDelay

animationDelay?: number | Function

Delay before updating the first animation, which supports callback function for different data to have different animation effect.

example

animationDelay: function (idx) { // delay for later data is larger return idx * 100; }

see

https://echarts.apache.org/en/option.html#animationDelay

Optional animationDelayUpdate

animationDelayUpdate?: number | Function

Delay before updating animation, which supports callback function for different data to have different animation effect.

example

animationDelayUpdate: function (idx) { // delay for later data is larger return idx * 100; }

see

https://echarts.apache.org/en/option.html#animationDelayUpdate

Optional animationDuration

animationDuration?: number

Duration of the first animation, which supports callback function for different data to have different animation effect

example

animationDuration: function (idx) { // delay for later data is larger return idx * 100; }

see

https://echarts.apache.org/en/option.html#animationDuration

Optional animationDurationUpdate

animationDurationUpdate?: number | Function

Time for animation to complete, which supports callback function for different data to have different animation effect

example

animationDurationUpdate: function (idx) { // delay for later data is larger return idx * 100; }

see

https://echarts.apache.org/en/option.html#animationDurationUpdate

Optional animationEasing

animationEasing?: string

Easing method used for the first animation. Varied easing effects can be found at easing effect example.

see

https://echarts.apache.org/en/option.html#animationEasing

Optional animationEasingUpdate

animationEasingUpdate?: string

Optional animationThreshold

animationThreshold?: number

Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.

see

https://echarts.apache.org/en/option.html#animationThreshold

Optional aria

aria?: object

dataset component is published since ECharts 4. dataset brings convenience in data management separated with styles and enables data reuse by different series. More importantly, is enables data encoding from data to visual, which brings convenience in some scenarios. More details about dataset can be checked in the tutorial.

see

https://echarts.apache.org/en/option.html#aria

Optional axisPointer

axisPointer?: any

axisPointer is a tool for displaying reference line and axis value under mouse pointer.

see

https://echarts.apache.org/en/option.html#axisPointer

Optional backgroundColor

backgroundColor?: any

Background color. Defaults to have no background.

see

https://echarts.apache.org/en/option.html#backgroundColor

Optional baseOption

baseOption?: any

Optional blendMode

blendMode?: string

Optional brush

brush?: object

brush is an area-selecting component, with which user can select part of data from a chart to display in detail, or doing calculations with them.

see

https://echarts.apache.org/en/option.html#brush

Optional calendar

calendar?: any

Calendar coordinates. In ECharts, we are very creative to achieve the calendar chart, by using the calendar coordinates to achieve the calendar chart, as shown in the following example, we can use calendar coordinates in heatmap, scatter, effectScatter, and graph.

see

https://echarts.apache.org/en/option.html#calendar

Optional color

color?: string[]

The color list of palette. If no color is set in series, the colors would be adopted sequentially and circularly from this list as the colors of series.

default

[ '#c23531','#2f4554','#61a0a8','#d48265','#91c7ae', '#749f83', '#ca8622','#bda29a','#6e7074','#546570', '#c4ccd3' ]

see

https://echarts.apache.org/en/option.html#color

Optional dataZoom

dataZoom?: any

dataZoom component is used for zooming a specific area, which enables user to investigate data in detail, or get an overview of the data, or get rid of outlier points. These types of dataZoom component are supported:

  • dataZoomInside: Data zoom functionalities is embeded inside coordinate systems, enable user to zoom or roam coordinate system by mouse dragging, mouse move or finger touch (in touch screen).
  • dataZoomSlider: A special slider bar is provided, on which coordinate systems can be zoomed or roamed by mouse dragging or finger touch (in touch screen).
  • dataZoomSelect: A marquee tool is provided for zooming or roaming coordinate system. That is toolbox.feature.dataZoom, which can only be configured in toolbox.
see

https://echarts.apache.org/en/option.html#dataZoom

Optional dataset

dataset?: any

Optional geo

geo?: object[]

Geographic coorinate system component. Geographic coorinate system component is used to draw maps, which also supports scatter series, and line series.

see

https://echarts.apache.org/en/option.html#geo

Optional geo3D

geo3D?: object[]

Optional globe

globe?: any[]

Optional graphic

graphic?: object | object[]

graphic component enable creating graphic elements in echarts. Those graphic type are supported. image, text, circle, sector, ring, polygon, polyline, rect, line, bezierCurve, arc, group,

see

https://echarts.apache.org/en/option.html#graphic

Optional grid

grid?: any

Drawing grid in rectangular coordinate. In a single grid, at most two X and Y axes each is allowed. Line chart, bar chart, and scatter chart (bubble chart) can be drawn in grid. In ECharts 2.x, there could only be one single grid component at most in a single echarts instance. But in ECharts 3, there is no limitation.

see

https://echarts.apache.org/en/option.html#grid

Optional grid3D

grid3D?: any[]

Optional hoverLayerThreshold

hoverLayerThreshold?: number

Threshold of if use single hover layer to optimize. It is recommended that hoverLayerThreshold is equivalent to or less than progressiveThreshold, otherwise hover will cause restart of progressive, which is unexpected. see example <echarts/test/heatmap-large.html>.

default

3000

Optional legend

legend?: any

Legend component. Legend component shows symbol, color and name of different series. You can click legends to toggle displaying series in the chart. In ECharts 3, a single echarts instance may contain multiple legend components, which makes it easier for the layout of multiple legend components. If there have to be too many legend items, vertically scrollable legend or horizontally scrollable legend are options to paginate them. Check legend.type please.

see

https://echarts.apache.org/en/option.html#legend

Optional options

options?: any

Optional parallel

parallel?: object

Parallel Coordinates is a common way of visualizing high-dimensional geometry and analyzing multivariate data. For example, series-parallel.data is the following data:

example

[ [1, 55, 9, 56, 0.46, 18, 6, 'good'], [2, 25, 11, 21, 0.65, 34, 9, 'excellent'], [3, 56, 7, 63, 0.3, 14, 5, 'good'], [4, 33, 7, 29, 0.33, 16, 6, 'excellent'], { // Data item can also be an Object, // so that perticular settings of its line can be set here. value: [5, 42, 24, 44, 0.76, 40, 16, 'excellent'] lineStyle: {...}, } ... ]

see

https://echarts.apache.org/en/option.html#parallel

Optional parallelAxis

parallelAxis?: object

This component is the coordinate axis for parallel coordinate.

see

https://echarts.apache.org/en/option.html#parallelAxis

Optional polar

polar?: object

Polar coordinate can be used in scatter and line chart. Every polar coordinate has an angleAxis and a radiusAxis.

see

https://echarts.apache.org/en/option.html#polar

Optional progressive

progressive?: number

Configuration for progressive/incremental rendering

default

400

Optional progressiveThreshold

progressiveThreshold?: number

Configuration for progressive/incremental rendering

default

3000

Optional radar

radar?: object

Coordinate for radar charts. This component is equal to the polar component in ECharts 2. Because the polar component in the echarts 3 is reconstructed to be the standard polar coordinate component, this component is renamed to be radar to avoid confusion. Radar chart coordinate is different from polar coordinate, in that every axis indicator of the radar chart coordinate is an individual dimension. The style of indicator coordinate axis could be configured through the following configuration items, including name, axisLine, axisTick, axisLabel, splitLine, splitArea.

see

https://echarts.apache.org/en/option.html#radar

Optional radiusAxis

radiusAxis?: object

Radial axis of polar coordinate.

see

https://echarts.apache.org/en/option.html#radiusAxis

Optional series

series?: any

Optional sharedVar

sharedVar?: ChartSharedVar

Chart Shared Var

Optional singleAxis

singleAxis?: any

An axis with a single dimension. It can be used to display data in one dimension.

see

https://echarts.apache.org/en/option.html#singleAxis

Optional textStyle

textStyle?: any

Optional timeline

timeline?: object

timeline component, which provides functions like switching and playing between multiple ECharts options.

see

https://echarts.apache.org/en/option.html#timeline

Optional title

Title component, including main title and subtitle. In ECharts 2.x, a single instance of ECharts could contains one title component at most. However, in ECharts 3, there could be one or more than one title components. It is more useful when multiple diagrams in one instance all need titles.

see

https://echarts.apache.org/en/option.html#title

Optional toolbox

toolbox?: object

A group of utility tools, which includes export, data view, dynamic type switching, data area zooming, and reset.

see

https://echarts.apache.org/en/option.html#toolbox

Optional tooltip

tooltip?: any

Tooltip component. It can be configured on different places:

  • Configured on global: tooltip
  • Configured in a coordinate system: grid.tooltip, polar.tooltip, single.tooltip
  • Configured in a series: series.tooltip
  • Configured in each item of series.data: series.data.tooltip
see

https://echarts.apache.org/en/option.html#tooltip

Optional url

url?: string

Optional useUTC

useUTC?: boolean

Whether to use UTC in display.

  • true: When axis.type is 'time', ticks is determined according to UTC, and axisLabel and tooltip use UTC by default.
  • false: When axis.type is 'time', ticks is determined according to local time, and axisLabel and tooltip use local time by default.

The default value of useUTC is false, for sake of considering:

  • In many cases, labels should be displayed in local time (whether the time is stored in server in local time or UTC).
  • If user uses time string (like '2012-01-02') in data, it usually means local time if time zone is not specified. Time should be displayed in its original time zone by default.

Notice: the setting only effects 'display time', but not 'parse time'. About how time value (like 1491339540396, '2013-01-04', ...) is parsed in echarts, see the time part in date.

see

https://echarts.apache.org/en/option.html#useUTC

Optional visualMap

visualMap?: any

visualMap is a type of component for visual encoding, which maps the data to visual channels, including:

  • symbol: Type of symbol.
  • symbolSize: Symbol size.
  • color: Symbol color.
  • colorAlpha: Symbol alpha channel.
  • opacity: Opacity of symbol and others (like labels).
  • colorLightness: Lightness in HSL.
  • colorSaturation: Saturation in HSL.
  • colorHue: Hue in HSL. Myltiple visualMap component could be defined in a chart instance, which enable that different dimensions of a series data are mapped to different visual channels. visualMap could be defined as Piecewise (visualMapPiecewise) or Continuous (visualMapContinuous), which is distinguished by the property type.
example

option = { visualMap: [ { // the first visualMap component type: 'continuous', // defined to be continuous viusalMap ... }, { // the sencond visualMap component type: 'piecewise', // defined to be piecewise visualMap ... } ], ... };

see

https://echarts.apache.org/en/option.html#visualMap

Optional xAxis

xAxis?: XAxis

The x axis in cartesian(rectangular) coordinate. Usually a single grid component can place at most 2 x axis, one on the bottom and another on the top. offset can be used to avoid overlap when you need to put more than two x axis.

see

https://echarts.apache.org/en/option.html#xAxis

Optional yAxis

yAxis?: YAxis

The y axis in cartesian(rectangular) coordinate. Usually a single grid component can place at most 2 y axis, one on the left and another on the right. offset can be used to avoid overlap when you need to put more than two y axis.

see

https://echarts.apache.org/en/option.html#yAxis

Generated using TypeDoc