ipecharts.option.option module#
- class ipecharts.option.option.Option(**kwargs: Any)[source]#
Bases:
BaseWidget- Warning:
Autogenerated class
- title Instance()#
- legend Instance()#
- grid Instance()#
- xAxis Instance()#
- yAxis Instance()#
- polar Instance()#
- radiusAxis Instance()#
- angleAxis Instance()#
- radar Instance()#
- dataZoom List(None)#
- visualMap List(None)#
- tooltip Instance()#
- axisPointer Instance()#
- toolbox Instance()#
- brush Instance()#
- geo Instance()#
- parallel Instance()#
- parallelAxis Instance()#
- singleAxis Instance()#
- timeline Instance()#
- graphic Instance()#
- calendar Instance()#
- dataset Instance()#
- aria Instance()#
- series List(None)#
- darkMode Bool(None)#
To specify whether it’s dark mode.
ECharts will automatically detect it via [backgroundColor](#backgroundColor) by default and adjust the text color accordingly.
This option is usually used in themes.
- color List(None)#
- backgroundColor Any(None)#
Background color. No background by default.
> Supports setting as solid color using rgb(255,255,255), rgba(255,255,255,1), #fff, etc. Also supports setting as gradient color and pattern fill, see [option.color](#color) for details
- textStyle Instance()#
- animation Bool(None)#
Whether to enable animation.
- animationThreshold Float(None)#
Whether to set graphic number threshold to animation. Animation will be disabled when graphic number is larger than threshold.
- animationDuration Union(None)#
Duration of the first animation, which supports callback function for different data to have different animation effect:
``` animationDuration: function (idx) {
// delay for later data is larger return idx * 100;
}
- animationEasing Unicode(None)#
Easing method used for the first animation. Varied easing effects can be found at [easing effect example](https://echarts.apache.org/examples/en/editor.html?c=line-easing).
- animationDelay Union(None)#
Delay before updating the first animation, which supports callback function for different data to have different animation effect.
For example:
``` animationDelay: function (idx) {
// delay for later data is larger return idx * 100;
}
See [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) for more information.
- animationDurationUpdate Union(None)#
Time for animation to complete, which supports callback function for different data to have different animation effect:
``` animationDurationUpdate: function (idx) {
// delay for later data is larger return idx * 100;
}
- animationEasingUpdate Unicode(None)#
Easing method used for animation.
- animationDelayUpdate Union(None)#
Delay before updating animation, which supports callback function for different data to have different animation effects.
For example:
``` animationDelayUpdate: function (idx) {
// delay for later data is larger return idx * 100;
}
See [this example](https://echarts.apache.org/examples/en/editor.html?c=bar-animation-delay) for more information.
- stateAnimation Instance()#
- blendMode Unicode(None)#
Sets the type of compositing operation to apply when drawing a new shape. See the different type: <https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation>.
The default is ‘source-over’. Support settings for each series.
‘lighter’ is also a common type of compositing operation. In this mode, the area where the number of graphics is concentrated is superimposed into a high-brightness color (white). It often used to highlight the effect of the area. See example [Global airline](https://echarts.apache.org/examples/en/editor.html?c=lines-airline)
- hoverLayerThreshold Float(None)#
When the number of element of the whole chart is larger than hoverLayerThreshold, a separate hover layer is used to render hovered elements.
The separate hover layer is used to avoid re-painting the whole canvas when hovering on elements. Instead, the hovered elements are rendered in a separate layer so that other elements don’t have to be rendered again.
ECharts 2 use separate layer for all cases. But it brings some problems like the hovered elements may not covering everything else correctly, or translucent elements may not overlay correctly to each other. And it brings extra member cost due to the extra canvas and may bring burden on mobile devices. So since ECharts 3, the hover layer is not used by default. Only when the element amount is large enough will the hover layer used.
- useUTC Bool(None)#
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 affects “display time”, not “parse time”. For how time value (like 1491339540396, ‘2013-01-04’, …) is parsed in echarts, see [the time part in date](#series-line.data).
- options List(None)#
- media List(None)#
- globe Instance()#
- geo3D Instance()#
- mapbox3D Instance()#
- grid3D Instance()#
- xAxis3D Instance()#
- yAxis3D Instance()#
- zAxis3D Instance()#