@types/echarts
Version:
TypeScript definitions for ECharts
1,211 lines (1,131 loc) • 279 kB
TypeScript
declare namespace echarts {
namespace EChartOption {
/**
* **Tree Diagram**
*
* The tree diagram is mainly used to visualize the tree data structure,
* which is a special hierarchical type with a unique root node, left
* subtree, and right subtree.
*
* **Note: Forests are not currently supported directly in a single
* series, and can be implemented by configuring multiple series in
* an option**
*
* **Tree example：**
*
* [see doc](https://echarts.apache.org/en/option.html#series-tree)
*
* **Multiple series are combined into forest：**
*
* [see doc](https://echarts.apache.org/en/option.html#series-tree)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree
*/
interface SeriesTree {
/**
* @default
* "tree"
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.name
*/
name?: string | undefined;
/**
* `zlevel` value of all graghical 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 seperate `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`.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.zlevel
*/
zlevel?: number | undefined;
/**
* `z` value of all graghical 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.
*
*
* @default
* 2
* @see https://echarts.apache.org/en/option.html#series-tree.z
*/
z?: number | undefined;
/**
* Distance between tree component and the left side of the container.
*
* `left` value can be instant pixel value like `20`; it can also
* be percentage value relative to container width like `'20%'`;
* and it can also be `'left'`, `'center'`, or `'right'`.
*
* If the `left` value is set to be `'left'`, `'center'`, or `'right'`,
* then the component will be aligned automatically based on position.
*
*
* @default
* 12%
* @see https://echarts.apache.org/en/option.html#series-tree.left
*/
left?: number | string | undefined;
/**
* Distance between tree component and the top side of the container.
*
* `top` value can be instant pixel value like `20`; it can also
* be percentage value relative to container width like `'20%'`;
* and it can also be `'top'`, `'middle'`, or `'bottom'`.
*
* If the `left` value is set to be `'top'`, `'middle'`, or `'bottom'`,
* then the component will be aligned automatically based on position.
*
*
* @default
* 12%
* @see https://echarts.apache.org/en/option.html#series-tree.top
*/
top?: number | string | undefined;
/**
* Distance between tree component and the right side of the container.
*
* `right` value can be instant pixel value like `20`; it can also
* be percentage value relative to container width like `'20%'`.
*
*
* @default
* 12%
* @see https://echarts.apache.org/en/option.html#series-tree.right
*/
right?: number | string | undefined;
/**
* Distance between tree component and the bottom side of the container.
*
* `bottom` value can be instant pixel value like `20`; it can also
* be percentage value relative to container width like `'20%'`.
*
*
* @default
* 12%
* @see https://echarts.apache.org/en/option.html#series-tree.bottom
*/
bottom?: number | string | undefined;
/**
* Width of tree component.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.width
*/
width?: number | string | undefined;
/**
* Height of tree component.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.height
*/
height?: number | string | undefined;
/**
* The layout of the tree, which can be `orthogonal` and `radial`
* 。Here the `orthogonal` layout is what we usually refer to the
* `horizontal` and `vertical` direction, the corresponding parameter
* value is `orthogonal`.
* The `radial` layout refers to the view that the root node as
* the center and each layer of nodes as the ring, the corresponding
* parameter value is `radial`.
*
* **Orthogonal Example：**
*
* [see doc](https://echarts.apache.org/en/option.html#series-tree.tree)
*
* **Radial Example：**
*
* [see doc](https://echarts.apache.org/en/option.html#series-tree.tree)
*
*
* @default
* "orthogonal"
* @see https://echarts.apache.org/en/option.html#series-tree.layout
*/
layout?: string | undefined;
/**
* The direction of the `orthogonal` layout in the tree diagram.
* That means this configuration takes effect only if `layout =
* 'orthogonal'`.
* The corresponding directions are `from left to right`, `from
* right to left`, `from top to bottom`, `from bottom to top`, with
* shorthand values `'LR'`, `'RL'`, `'TB'`, `'BT'`.
* **Note: The previous configuration value `'horizontal'` is equivalent
* to `'LR'`, `'vertical'` is equivalent to `'TB'`.**
*
*
* @default
* "LR"
* @see https://echarts.apache.org/en/option.html#series-tree.orient
*/
orient?: string | undefined;
/**
* Symbol of .
*
* 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-tree.tree)
*
* 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-tree.tree)
*
*
* @default
* "emptyCircle"
* @see https://echarts.apache.org/en/option.html#series-tree.symbol
*/
symbol?: string | undefined;
/**
* 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-tree.data)
* , and the second parameter `params` is the rest parameters of
* data item.
*
*
* @default
* 7
* @see https://echarts.apache.org/en/option.html#series-tree.symbolSize
*/
symbolSize?: any[] | Function | number | undefined;
/**
* Rotate degree of 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-tree.symbolRotate
*/
symbolRotate?: number | undefined;
/**
* Whether to keep aspect for symbols in the form of `path://`.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.symbolKeepAspect
*/
symbolKeepAspect?: boolean | undefined;
/**
* Offset of 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-tree.symbolOffset
*/
symbolOffset?: any[] | 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-tree.roam
*/
roam?: boolean | string | undefined;
/**
* Subtree collapses and expands interaction, `default true`.
* As the drawing area is limited, and usually the nodes of a tree
* may be more, so there will be hidden between the nodes.
* In order to avoid this problem, you can put a temporary unrelated
* subtree folded away, until you need to start when necessary.
* Such as the above radial layout tree example, the center of the
* node is filled with blue is the folded away subtree, you can
* click to expand it.
*
* **Note: If you configure a custom image as the tag for a node,
* it is not possible to distinguish whether the current node has
* a collapsed subtree by the fill color.
* And currently do not support, upload two pictures, respectively
* represent the collapsing and expansion state of the node.
* So, if you want to explicitly show the two states of the node,
* it is recommended to use `ECharts` regular tag types, such as
* `emptyCircle`.**
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-tree.expandAndCollapse
*/
expandAndCollapse?: boolean | undefined;
/**
* The initial level (depth) of the tree.
* The root node is the 0th layer, then the first layer, the second
* layer,
*
*
*
* , until the leaf node.
* This configuration item is primarily used in conjunction with
* `collapsing and expansion` interactions.
* The purpose is to prevent the nodes from obscuring each other.
* If set as -1 or `null` or `undefined`, all nodes are expanded.
*
*
* @default
* 2
* @see https://echarts.apache.org/en/option.html#series-tree.initialTreeDepth
*/
initialTreeDepth?: number | undefined;
/**
* The style of each node in the tree, where \[itemStyle.color\]
* (~ series-tree.itemStyle.color)
* represents the fill color of the node, to distinguish the state
* of the subtree corresponding to `collapsing` or `expansion`.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.itemStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.itemStyle.color
*/
color?: EChartOption.Color | undefined;
/**
* border color, whose format is similar to that of `color`.
*
*
* @default
* "#c23531"
* @see https://echarts.apache.org/en/option.html#series-tree.itemStyle.borderColor
*/
borderColor?: EChartOption.Color | undefined;
/**
* border width. No border when it is set to be 0.
*
*
* @default
* 1.5
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.tree.itemStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.itemStyle.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow color. Support same format as `color`.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.itemStyle.shadowColor
*/
shadowColor?: EChartOption.Color | undefined;
/**
* Offset distance on the horizontal direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.itemStyle.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Offset distance on the vertical direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.itemStyle.opacity
*/
opacity?: number | undefined;
} | undefined;
/**
* `label` describes the style of the text corresponding to each
* node.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label
*/
label?: {
/**
* Whether to show label.
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.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)
* .
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.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-tree.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-tree.tree.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.label.color
*/
color?: string | undefined;
/**
* font style
*
* Options are:
*
* + `'normal'`
* + `'italic'`
* + `'oblique'`
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.label.fontFamily
*/
fontFamily?: string | undefined;
/**
* font size
*
*
* @default
* 12
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.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-tree.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-tree.label.borderColor
*/
borderColor?: string | undefined;
/**
* Border width of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.borderWidth
*/
borderWidth?: number | undefined;
/**
* Border radius of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.label.padding
*/
padding?: any[] | number | undefined;
/**
* Shadow color of the text block.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-tree.label.shadowColor
*/
shadowColor?: string | undefined;
/**
* Show blur of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow X offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.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-tree.label.textBorderColor
*/
textBorderColor?: string | undefined;
/**
* Storke line width of the text.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.textBorderWidth
*/
textBorderWidth?: number | undefined;
/**
* Shadow color of the text itself.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-tree.label.textShadowColor
*/
textShadowColor?: string | undefined;
/**
* Shadow blue of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.textShadowBlur
*/
textShadowBlur?: number | undefined;
/**
* Shadow X offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.textShadowOffsetX
*/
textShadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.tree.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-tree.label.rich
*/
rich?: {
/**
* @see https://echarts.apache.org/en/option.html#series-tree.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-tree.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-tree.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-tree.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight
*/
fontWeight?: string | number | undefined;
/**
* font family
*
* Can also be 'serif' , 'monospace', ...
*
*
* @default
* "sans-serif"
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily
*/
fontFamily?: string | undefined;
/**
* font size
*
*
* @default
* 12
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.tree.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.tree.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.tree.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.tree.label.rich.%3Cuser%20defined%20style%20name%3E)
*
* `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-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor
*/
borderColor?: string | undefined;
/**
* Border width of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth
*/
borderWidth?: number | undefined;
/**
* Border radius of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.label.rich.%3Cuser%20defined%20style%20name%3E.padding
*/
padding?: any[] | number | undefined;
/**
* Shadow color of the text block.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor
*/
shadowColor?: string | undefined;
/**
* Show blur of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow X offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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-tree.label.rich.%3Cuser%20defined%20style%20name%3E.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`).
*