@types/echarts
Version:
TypeScript definitions for ECharts
1,281 lines (1,198 loc) • 1.04 MB
TypeScript
declare namespace echarts {
namespace EChartOption {
/**
* **relation graph**
*
* Graph is a diagram to represent
* [nodes](https://echarts.apache.org/en/option.html#series-graph.nodes)
* and the
* [links](https://echarts.apache.org/en/option.html#series-graph.links)
* connecting nodes.
*
* **Tips:** In ECharts 2.x
* , the diagram of `force` type will not be available in ECharts 3
* any more, which has been changed to use `graph` to show graph data.
* If you want to use force to lead the layout, you can set the
* [layout](https://echarts.apache.org/en/option.html#series-graph.layout)
* configuration as `'force'`.
*
* **Example:**
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph
*/
interface SeriesGraph {
/**
* @default
* "graph"
* @see https://echarts.apache.org/en/option.html#series-graph.type
*/
type?: string | undefined;
/**
* Component ID, not specified by default.
* If specified, it can be used to refer the component in option
* or API.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.id
*/
id?: string | undefined;
/**
* Series name used for displaying in
* [tooltip](https://echarts.apache.org/en/option.html#tooltip)
* and filtering with
* [legend](https://echarts.apache.org/en/option.html#legend)
* , or updaing data and configuration with `setOption`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.name
*/
name?: string | undefined;
/**
* Whether to enable highlighting chart when
* [legend](https://echarts.apache.org/en/option.html#legend)
* is being hovered.
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-graph.legendHoverLink
*/
legendHoverLink?: boolean | undefined;
/**
* The coordinate used in the series, whose options are:
*
* + `null` or `'none'`
*
* No coordinate.
*
* + `'cartesian2d'`
*
* Use a two-dimensional rectangular coordinate (also known as Cartesian
* coordinate), with
* [xAxisIndex](https://echarts.apache.org/en/option.html#series-graph.xAxisIndex)
* and
* [yAxisIndex](https://echarts.apache.org/en/option.html#series-graph.yAxisIndex)
* to assign the corresponding axis component.
*
* + `'polar'`
*
* Use polar coordinates, with
* [polarIndex](https://echarts.apache.org/en/option.html#series-graph.polarIndex)
* to assign the corresponding polar coordinate component.
*
* + `'geo'`
*
* Use geographic coordinate, with
* [geoIndex](https://echarts.apache.org/en/option.html#series-graph.geoIndex)
* to assign the corresponding geographic coordinate components.
*
* + `'none'`
*
* Do not use coordinate system.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.coordinateSystem
*/
coordinateSystem?: string | undefined;
/**
* Index of
* [x axis](https://echarts.apache.org/en/option.html#xAxis)
* to combine with, which is useful for multiple x axes in one chart.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.xAxisIndex
*/
xAxisIndex?: number | undefined;
/**
* Index of
* [y axis](https://echarts.apache.org/en/option.html#yAxis)
* to combine with, which is useful for multiple y axes in one chart.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.yAxisIndex
*/
yAxisIndex?: number | undefined;
/**
* Index of
* [polar coordinate](https://echarts.apache.org/en/option.html#polar)
* to combine with, which is useful for multiple polar axes in one
* chart.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.polarIndex
*/
polarIndex?: number | undefined;
/**
* Index of
* [geographic coordinate](https://echarts.apache.org/en/option.html#geo)
* to combine with, which is useful for multiple geographic axes
* in one chart.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.geoIndex
*/
geoIndex?: number | undefined;
/**
* Index of
* [calendar coordinates](https://echarts.apache.org/en/option.html#calendar)
* to combine with, which is useful for multiple calendar coordinates
* in one chart.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.calendarIndex
*/
calendarIndex?: number | undefined;
/**
* Whether to enable the highlight animation effect of mousr hover
* node.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.hoverAnimation
*/
hoverAnimation?: boolean | undefined;
/**
* Graph layout.
*
* **Options:**
*
* + `'none'` No any layout, use
* [x](https://echarts.apache.org/en/option.html#series-graph.data.x)
* ,
* [y](https://echarts.apache.org/en/option.html#series-graph.data.y)
* provided in
* [node](https://echarts.apache.org/en/option.html#series-graph.data)
* as the position of node.
*
* + `'circular'` Adopt circular layout, see the example
* [Les Miserables](https://echarts.apache.org/examples/en/editor.html?c=graph-circular-layout)
* .
*
* + `'force'` Adopt force-directed layout, see the example
* [Force](https://echarts.apache.org/examples/en/editor.html?c=graph-force)
* , the detail about configrations of layout are in
* [graph.force](https://echarts.apache.org/en/option.html#series-graph.force)
*
*
* @default
* "none"
* @see https://echarts.apache.org/en/option.html#series-graph.layout
*/
layout?: string | undefined;
/**
* Configuration about circular layout.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.circular
*/
circular?: {
/**
* Whether to rotate the label automatically.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.circular.rotateLabel
*/
rotateLabel?: boolean | undefined;
} | undefined;
/**
* Configuration items about force-directed layout.
* Force-directed layout simulates spring/charge model, which will
* add a repulsion between 2 nodes and add a attraction between
* 2 nodes of each edge.
* In each iteration nodes will move under the effect of repulsion
* and attraction.
* After several iterations, the nodes will be static in a balanced
* position.
* As a result, the energy local minimum of this whole model will
* be realized.
*
* The result of force-directed layout has a good symmetries and
* clustering, which is also aesthetically pleasing.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.force
*/
force?: {
/**
* The initial layout before force-directed layout, which will
* influence on the result of force-directed layout.
*
* It defaults not to do any layout and use
* [x](https://echarts.apache.org/en/option.html#series-graph.data.x)
* ,
* [y](https://echarts.apache.org/en/option.html#series-graph.data.y)
* provided in
* [node](https://echarts.apache.org/en/option.html#series-graph.data)
* as the position of node.
* If it doesn't exist, the position will be generated randomly.
*
* You can also use circular layout `'circular'`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.force.initLayout
*/
initLayout?: string | undefined;
/**
* The repulsion factor between nodes.
* The repulsion will be stronger and the distance between 2
* nodes becomes further as this value becomes larger.
*
* It can be an array to represent the range of repulsion.
* In this case larger value have larger repulsion and smaller
* value will have smaller repulsion.
*
*
* @default
* 50
* @see https://echarts.apache.org/en/option.html#series-graph.force.repulsion
*/
repulsion?: any[] | number | undefined;
/**
* The gravity factor enforcing nodes approach to the center.
* The nodes will be closer to the center as the value becomes
* larger.
*
*
* @default
* 0.1
* @see https://echarts.apache.org/en/option.html#series-graph.force.gravity
*/
gravity?: number | undefined;
/**
* The distance between 2 nodes on edge.
* This distance is also affected by
* [repulsion](https://echarts.apache.org/en/option.html#series-graph.force.repulsion)
* .
*
* It can be an array to represent the range of edge length.
* In this case edge with larger value will be shorter, which
* means two nodes are closer.
* And edge with smaller value will be longer.
*
*
* @default
* 30
* @see https://echarts.apache.org/en/option.html#series-graph.force.edgeLength
*/
edgeLength?: any[] | number | undefined;
/**
* Because the force-directed layout will be steady after several
* iterations, this parameter will be decide whether to show
* the iteration animation of layout.
* It is not recommended to be closed on browser when there
* are a lot of node data (>100) as the layout process will
* cause browser to hang.
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-graph.force.layoutAnimation
*/
layoutAnimation?: boolean | undefined;
/**
* It will slow down the nodes' movement. The value range is from 0 to 1.
* But it is still an experimental option, see [#11024](https://github.com/apache/incubator-echarts/issues/11024).
*
* Since v4.5.0
*
* @default
* 0.6
* @see https://echarts.apache.org/en/option.html#series-graph.force.friction
*/
friction?: number | undefined;
} | undefined;
/**
* Whether to enable mouse zooming and translating.
* `false` by default.
* If either zooming or translating is wanted, it can be set to
* `'scale'` or `'move'`.
* Otherwise, set it to be `true` to enable both.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.roam
*/
roam?: boolean | string | undefined;
/**
* Related zooming ratio of nodes when mouse zooming in or out.
* When it is set as 0, the node will not zoom as the mouse zooms.
*
*
* @default
* 0.6
* @see https://echarts.apache.org/en/option.html#series-graph.nodeScaleRatio
*/
nodeScaleRatio?: number | undefined;
/**
* If node is draggable.
* Only available when using force-directed layout.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.draggable
*/
draggable?: boolean | undefined;
/**
* Symbol of node of relation graph.
*
* Icon types provided by ECharts includes `'circle'`, `'rect'`,
* `'roundRect'`, `'triangle'`, `'diamond'`, `'pin'`, `'arrow'`,
* `'none'`
*
* It can be set to an image with `'image://url'` , in which URL
* is the link to an image, or `dataURI` of an image.
*
* An image URL example:
*
* ```
* 'image://http://xxx.xxx.xxx/a/b.png'
*
* ```
*
* A `dataURI` example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph)
*
* Icons can be set to arbitrary vector path via `'path://'` in
* ECharts.
* As compared with raster image, vector paths prevent from jagging
* and blurring when scaled, and have a better control over changing
* colors.
* Size of vectoer icon will be adapted automatically. Refer to
* [SVG PathData](http://www.w3.org/TR/SVG/paths.html#PathData)
* for more information about format of path.
* You may export vector paths from tools like Adobe Illustrator.
*
* For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph)
*
*
* @default
* "circle"
* @see https://echarts.apache.org/en/option.html#series-graph.symbol
*/
symbol?: string | undefined;
/**
* node of relation graph symbol size.
* It can be set to single numbers like `10`, or use an array to
* represent width and height.
* For example, `[20, 10]` means symbol width is `20`, and height
* is`10`.
*
* If size of symbols needs to be different, you can set with callback
* function in the following format:
*
* ```
* (value: Array|number, params: Object) => number|Array
*
* ```
*
* The first parameter `value` is the value in
* [data](https://echarts.apache.org/en/option.html#series-.data)
* , and the second parameter `params` is the rest parameters of
* data item.
*
*
* @default
* 10
* @see https://echarts.apache.org/en/option.html#series-graph.symbolSize
*/
symbolSize?: any[] | Function | number | undefined;
/**
* Rotate degree of node of relation graph symbol.
* Note that when `symbol` is set to be `'arrow'` in `markLine`,
* `symbolRotate` value will be ignored, and compulsively use tangent
* angle.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.symbolRotate
*/
symbolRotate?: number | undefined;
/**
* Whether to keep aspect for symbols in the form of `path://`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.symbolKeepAspect
*/
symbolKeepAspect?: boolean | undefined;
/**
* Offset of node of relation graph symbol relative to original
* position.
* By default, symbol will be put in the center position of data.
* But if symbol is from user-defined vector path or image, you
* may not expect symbol to be in center.
* In this case, you may use this attribute to set offset to default
* position.
* It can be in absolute pixel value, or in relative percentage
* value.
*
* For example, `[0, '50%']` means to move upside side position
* of symbol height.
* It can be used to make the arrow in the bottom to be at data
* position when symbol is pin.
*
*
* @default
* [0, 0]
* @see https://echarts.apache.org/en/option.html#series-graph.symbolOffset
*/
symbolOffset?: any[] | undefined;
/**
* Whether to focus/highlight the hover node and it's adjacencies.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.focusNodeAdjacency
*/
focusNodeAdjacency?: boolean | undefined;
/**
* Symbol of two ends of edge line.
*
* For example:
*
* ```
* edgeSymbol: ['circle', 'arrow']
*
* ```
*
*
* @default
* "[none', 'none']"
* @see https://echarts.apache.org/en/option.html#series-graph.edgeSymbol
*/
edgeSymbol?: any[] | string | undefined;
/**
* Size of symbol of two ends of edge line.
* Can be an array or a single number.
*
* For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph)
*
*
* @default
* 10
* @see https://echarts.apache.org/en/option.html#series-graph.edgeSymbolSize
*/
edgeSymbolSize?: any[] | number | undefined;
/**
* The mouse style when mouse hovers on an element, the same as
* `cursor` property in `CSS`.
*
*
* @default
* "pointer"
* @see https://echarts.apache.org/en/option.html#series-graph.cursor
*/
cursor?: string | undefined;
/**
* Graphic style of , `emphasis` is the style when it is highlighted,
* like being hovered by mouse, or highlighted via legend connect.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle
*/
itemStyle?: {
/**
* color. Color is taken from
* [option.color Palette](https://echarts.apache.org/en/option.html#color)
* by default.
*
* > Color can be represented in RGB, for example `'rgb(128,
* 128, 128)'`.
* RGBA can be used when you need alpha channel, for example
* `'rgba(128, 128, 128, 0.5)'`.
* You may also use hexadecimal format, for example `'#ccc'`.
* Gradient color and texture are also supported besides single
* colors.
* >
* > [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.itemStyle)
*
* Supports callback functions, in the form of:
*
* ```
* (params: Object) => Color
*
* ```
*
* Input parameters are `seriesIndex`, `dataIndex`, `data`,
* `value`, and etc. of data item.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.color
*/
color?: EChartOption.Color | Function | undefined;
/**
* border color, whose format is similar to that of `color`.
*
*
* @default
* "#000"
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderColor
*/
borderColor?: EChartOption.Color | undefined;
/**
* border width. No border when it is set to be 0.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderWidth
*/
borderWidth?: number | undefined;
/**
* Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`.
* `'solid'` by default.
*
*
* @default
* "solid"
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.borderType
*/
borderType?: string | undefined;
/**
* Size of shadow blur.
* This attribute should be used along with `shadowColor`,`shadowOffsetX`,
* `shadowOffsetY` to set shadow to component.
*
* For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.itemStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow color. Support same format as `color`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowColor
*/
shadowColor?: EChartOption.Color | undefined;
/**
* Offset distance on the horizontal direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Offset distance on the vertical direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.shadowOffsetY
*/
shadowOffsetY?: number | undefined;
/**
* Opacity of the component.
* Supports value from 0 to 1, and the component will not be
* drawn when set to 0.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.itemStyle.opacity
*/
opacity?: number | undefined;
} | undefined;
/**
* The style of edge line.
* [lineStyle.color](https://echarts.apache.org/en/option.html#series-graph.lineStyle.color)
* can be `'source'` or `'target'`, which will use the color of
* source node or target node.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle
*/
lineStyle?: {
/**
* Line color.
*
* > Color can be represented in RGB, for example `'rgb(128,
* 128, 128)'`.
* RGBA can be used when you need alpha channel, for example
* `'rgba(128, 128, 128, 0.5)'`.
* You may also use hexadecimal format, for example `'#ccc'`.
* Gradient color and texture are also supported besides single
* colors.
* >
* > [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.lineStyle)
*
*
* @default
* "#aaa"
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.color
*/
color?: EChartOption.Color | undefined;
/**
* line width.
*
*
* @default
* 1
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.width
*/
width?: number | undefined;
/**
* line type.
*
* Options are:
*
* + `'solid'`
* + `'dashed'`
* + `'dotted'`
*
*
* @default
* "solid"
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.type
*/
type?: string | undefined;
/**
* Size of shadow blur.
* This attribute should be used along with `shadowColor`,`shadowOffsetX`,
* `shadowOffsetY` to set shadow to component.
*
* For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.lineStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow color. Support same format as `color`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowColor
*/
shadowColor?: EChartOption.Color | undefined;
/**
* Offset distance on the horizontal direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Offset distance on the vertical direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.shadowOffsetY
*/
shadowOffsetY?: number | undefined;
/**
* Opacity of the component.
* Supports value from 0 to 1, and the component will not be
* drawn when set to 0.
*
*
* @default
* 0.5
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.opacity
*/
opacity?: number | undefined;
/**
* Edge curvature, which supports value from 0 to 1.
* The larger the value, the greater the curvature.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.lineStyle.curveness
*/
curveness?: number | undefined;
} | undefined;
/**
* Text label of , to explain some data information about graphic
* item like value, name and so on.
* `label` is placed under `itemStyle` in ECharts 2.x.
* In ECharts 3, to make the configuration structure flatter, `label`is
* taken to be at the same level with `itemStyle`, and has `emphasis`
* as `itemStyle` does.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label
*/
label?: {
/**
* Whether to show label.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.show
*/
show?: boolean | undefined;
/**
* Label position.
*
* **Followings are the options:**
*
* + \[x, y\]
*
* Use relative percentage, or absolute pixel values to represent
* position of label relative to top-left corner of bounding
* box. For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
* + 'top'
*
* + 'left'
* + 'right'
* + 'bottom'
* + 'inside'
* + 'insideLeft'
* + 'insideRight'
* + 'insideTop'
* + 'insideBottom'
* + 'insideTopLeft'
* + 'insideBottomLeft'
* + 'insideTopRight'
* + 'insideBottomRight'
*
* See:
* [label position](https://echarts.apache.org/examples/en/view.html?c=doc-example/label-position)
* .
*
*
* @default
* "inside"
* @see https://echarts.apache.org/en/option.html#series-graph.label.position
*/
position?: any[] | string | undefined;
/**
* Distance to the host graphic element.
* Works when position is string value (like `'top'`、`'insideRight'`).
*
* See:
* [label position](https://echarts.apache.org/examples/en/editor.html?c=doc-example/label-position)
* .
*
*
* @default
* 5
* @see https://echarts.apache.org/en/option.html#series-graph.label.distance
*/
distance?: number | undefined;
/**
* Rotate label, from -90 degree to 90, positive value represents
* rotate anti-clockwise.
*
* See:
* [label rotation](https://echarts.apache.org/examples/en/editor.html?c=bar-label-rotation)
* .
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.rotate
*/
rotate?: number | undefined;
/**
* Whether to move text slightly.
* For example: `[30, 40]` means move `30` horizontally and
* move `40` vertically.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.offset
*/
offset?: any[] | undefined;
/**
* Data label formatter, which supports string template and
* callback function.
* In either form, `\n` is supported to represent a new line.
*
* **String template**
*
* Model variation includes:
*
* + `{a}`: series name.
* + `{b}`: the name of a data item.
* + `{c}`: the value of a data item.
* + `{d}`: the percent.
* + `{@xxx}: the value of a dimension named`'xxx'`, for example,`{@product}`refers
* the value of`'product'\` dimension。
* + `{@[n]}: the value of a dimension at the index of`n`, for
* example,`{@\[3\]}\` refers the value at dimensions\[3\].
*
* **example:**
*
* ```
* formatter: '{b}: {d}'
*
* ```
*
* **Callback function**
*
* Callback function is in form of:
*
* ```
* (params: Object|Array) => string
*
* ```
*
* where `params` is the single dataset needed by formatter,
* which is formed as:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.formatter
*/
formatter?: Function | string | undefined;
/**
* text color.
*
* If set as `'auto'`, the color will assigned as visual color,
* such as series color.
*
*
* @default
* ""#fff""
* @see https://echarts.apache.org/en/option.html#series-graph.label.color
*/
color?: string | undefined;
/**
* font style
*
* Options are:
*
* + `'normal'`
* + `'italic'`
* + `'oblique'`
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-graph.label.fontStyle
*/
fontStyle?: string | undefined;
/**
* font thick weight
*
* Options are:
*
* + `'normal'`
* + `'bold'`
* + `'bolder'`
* + `'lighter'`
* + 100 | 200 | 300 | 400...
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-graph.label.fontWeight
*/
fontWeight?: string | number | undefined;
/**
* font family
*
* Can also be 'serif' , 'monospace', ...
*
*
* @default
* "sans-serif"
* @see https://echarts.apache.org/en/option.html#series-graph.label.fontFamily
*/
fontFamily?: string | undefined;
/**
* font size
*
*
* @default
* 12
* @see https://echarts.apache.org/en/option.html#series-graph.label.fontSize
*/
fontSize?: number | undefined;
/**
* Horizontal alignment of text, automatic by default.
*
* Options are:
*
* + `'left'`
* + `'center'`
* + `'right'`
*
* If `align` is not set in `rich`, `align` in parent level
* will be used. For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.align
*/
align?: string | undefined;
/**
* Vertical alignment of text, automatic by default.
*
* Options are:
*
* + `'top'`
* + `'middle'`
* + `'bottom'`
*
* If `verticalAlign` is not set in `rich`, `verticalAlign`
* in parent level will be used. For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.verticalAlign
*/
verticalAlign?: string | undefined;
/**
* Line height of the text fregment.
*
* If `lineHeight` is not set in `rich`, `lineHeight` in parent
* level will be used. For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.lineHeight
*/
lineHeight?: number | undefined;
/**
* Background color of the text fregment.
*
* Can be color string, like `'#123234'`, `'red'`, `rgba(0,23,11,0.3)'`.
*
* Or image can be used, for example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
* `width` or `height` can be specified when using background
* image, or auto adapted by default.
*
* If set as `'auto'`, the color will assigned as visual color,
* such as series color.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-graph.label.backgroundColor
*/
backgroundColor?: object | string | undefined;
/**
* Border color of the text fregment.
*
* If set as `'auto'`, the color will assigned as visual color,
* such as series color.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-graph.label.borderColor
*/
borderColor?: string | undefined;
/**
* Border width of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.borderWidth
*/
borderWidth?: number | undefined;
/**
* Border radius of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.borderRadius
*/
borderRadius?: number | undefined;
/**
* Padding of the text fregment, for example:
*
* + `padding: [3, 4, 5, 6]`: represents padding of `[top, right,
* bottom, left]`.
* + `padding: 4`: represents `padding: [4, 4, 4, 4]`.
* + `padding: [3, 4]`: represents `padding: [3, 4, 3, 4]`.
*
* Notice, `width` and `height` specifies the width and height
* of the content, without `padding`.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.padding
*/
padding?: any[] | number | undefined;
/**
* Shadow color of the text block.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-graph.label.shadowColor
*/
shadowColor?: string | undefined;
/**
* Show blur of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow X offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.shadowOffsetY
*/
shadowOffsetY?: number | undefined;
/**
* Width of the text block.
* It is the width of the text by default.
* In most cases, there is no need to specify it.
* You may want to use it in some cases like make simple table
* or using background image (see `backgroundColor`).
*
* Notice, `width` and `height` specifies the width and height
* of the content, without `padding`.
*
* `width` can also be percent string, like `'100%'`, which
* represents the percent of `contentWidth` (that is, the width
* without `padding`) of its container box.
* It is based on `contentWidth` because that each text fregment
* is layout based on the `content box`, where it makes no sense
* that calculating width based on `outerWith` in prectice.
*
* Notice, `width` and `height` only work when `rich` specified.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.width
*/
width?: number | string | undefined;
/**
* Height of the text block.
* It is the width of the text by default.
* You may want to use it in some cases like using background
* image (see `backgroundColor`).
*
* Notice, `width` and `height` specifies the width and height
* of the content, without `padding`.
*
* Notice, `width` and `height` only work when `rich` specified.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.height
*/
height?: number | string | undefined;
/**
* Storke color of the text.
*
* If set as `'auto'`, the color will assigned as visual color,
* such as series color.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-graph.label.textBorderColor
*/
textBorderColor?: string | undefined;
/**
* Storke line width of the text.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.textBorderWidth
*/
textBorderWidth?: number | undefined;
/**
* Shadow color of the text itself.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowColor
*/
textShadowColor?: string | undefined;
/**
* Shadow blue of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowBlur
*/
textShadowBlur?: number | undefined;
/**
* Shadow X offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowOffsetX
*/
textShadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.textShadowOffsetY
*/
textShadowOffsetY?: number | undefined;
/**
* "Rich text styles" can be defined in this `rich` property.
* For example:
*
* [see doc](https://echarts.apache.org/en/option.html#series-graph.graph.label)
*
* For more details, see
* [Rich Text](https://echarts.apache.org/en/option.htmltutorial.html#Rich%20Text)
* please.
*
*
* @see https://echarts.apache.org/en/option.html#series-graph.label.rich
*/
rich?: {
/**
* @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E
*/
[userStyle: string]: {
/**
* text color.
*
* If set as `'auto'`, the color will assigned as visual
* color, such as series color.
*
*
* @default
* ""#fff""
* @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.color
*/
color?: string | undefined;
/**
* font style
*
* Options are:
*
* + `'normal'`
* + `'italic'`
* + `'oblique'`
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle
*/
fontStyle?: string | undefined;
/**
* font thick weight
*
* Options are:
*
* + `'normal'`
* + `'bold'`
* + `'bolder'`
* + `'lighter'`
* + 100 | 200 | 300 | 400...
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight
*/
fontWeight?: string | number | undefined;
/**
* font family
*
* Can also be 'serif' , 'monospace', ...
*
*
* @default
* "sans-serif"
* @see https:/