ipecharts.option.seriesitems.gauge module#

class ipecharts.option.seriesitems.gauge.Gauge(**kwargs: Any)[source]#

Bases: BaseWidget

Warning:: Autogenerated class

Gauge chart

Example:

type Unicode('gauge')#

id Unicode(None)#: Component ID, not specified by default. If specified, it can be used to refer the component in option or API.

name Unicode(None)#: Series name used for displaying in [tooltip](#tooltip) and filtering with [legend](#legend), or updating data and configuration with setOption.

colorBy Unicode(None)#

> Since v5.2.0

The policy to take color from [option.color](#color). Valid values:

‘series’: assigns the colors in the palette by series, so that all data in the same series are in the same color;
‘data’: assigns colors in the palette according to data items, with each data item using a different color.

zlevel Float(None)#

zlevel value of all graphical elements in .

zlevel is used to make layers with Canvas. Graphical elements with different zlevel values will be placed in different Canvases, which is a common optimization technique. We can put those frequently changed elements (like those with animations) to a separate zlevel. Notice that too many Canvases will increase memory cost, and should be used carefully on mobile phones to avoid crash.

Canvases with bigger zlevel will be placed on Canvases with smaller zlevel.

z Float(None)#

z value of all graphical elements in , which controls order of drawing graphical components. Components with smaller z values may be overwritten by those with larger z values.

z has a lower priority to zlevel, and will not create new Canvas.

center Any(None)#

Center position of , the first of which is the horizontal position, and the second is the vertical position.

Percentage is supported. When set in percentage, the item is relative to the container width, and the second item to the height.

Example:

``` // Set to absolute pixel values center: [400, 300] // Set to relative percent center: [‘50%’, ‘50%’]

```

radius Union(None)#: The radius of gauge chart. It can be a percentage value of the smaller of container half width and half height, also can be an absolute value.

legendHoverLink Bool(None)#: Whether to enable highlighting chart when [legend](#legend) is being hovered.

startAngle Float(None)#: The start angle of gauge chart. The direct right side of [circle center](#series-gauge.center) is 0 degree, the right above it is 90 degree, the direct left side of it is 180 degree.

endAngle Float(None)#: The end angle of gauge chart.

clockwise Bool(None)#: Whether the scale in gauge chart increases clockwise.

data Any(None)#

Data array of series, which can be a single data value, like:

``` [12, 34, 56, 10, 23]

```

Or, if need extra dimensions for components like [visualMap](#visualMap) to map to graphic attributes like color, it can also be in the form of array. For example:

``` [[12, 14], [34, 50], [56, 30], [10, 15], [23, 10]]

```

In this case, we can assign the second value in each array item to [visualMap](#visualMap) component.

More likely, we need to assign name to each data item, in which case each item should be an object:

``` [{

// name of date item name: ‘data1’, // value of date item is 8 value: 10

}, {: name: ‘data2’, value: 20

}]

```

Each data item can be further customized:

``` [{

name: ‘data1’, value: 10

}, {: // name of data item name: ‘data2’, value : 56, // user-defined label format that only useful for this data item label: {}, // user-defined special itemStyle that only useful for this data item itemStyle:{}

}]

```

min Float(None)#: The minimum data value which map to [minAngle](#series-gauge.minAngle).

max Float(None)#: The maximum data value which map to [maxAngle](#series-gauge.maxAngle).

splitNumber Float(None)#: The number of split segments of gauge chart scale.

axisLine Dict()#: The related configuration about the axis line of gauge chart.

progress Dict()#

> Since v5.0

Used to show current progress.

splitLine Dict()#: The style of split line.

axisTick Dict()#: The tick line style.

axisLabel Dict()#: Axis tick label.

pointer Dict()#: Gauge chart pointer.

anchor Dict()#

> Since v5.0

The fixed point of a pointer in a dial.

itemStyle Dict()#: The style of gauge chart.

emphasis Dict()#: Configurations of emphasis state.

title Dict()#: The title of gauge chart.

detail Dict()#: The detail about gauge chart which is used to show data.

markPoint Dict()#: Mark point in a chart.

markLine Dict()#: Use a line in the chart to illustrate.

markArea Dict()#: Used to mark an area in chart. For example, mark a time interval.

silent Bool(None)#: Whether to ignore mouse events. Default value is false, for triggering and responding to mouse events.

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) {