@types/echarts
Version:
TypeScript definitions for ECharts
1,209 lines (1,124 loc) • 197 kB
TypeScript
declare namespace echarts {
namespace EChartOption {
/**
* **Sankey Graphs**
*
* Sankey diagram is a specific type of streamgraphs(can also be seen
* as a directed acyclic graph).
* In which the width of each branch is shown proportionally to the
* flow quantity.
* These graphs are typically used to visualize energy or material or
* cost transfers between processes.
* They can also visualize the energy accounts, material flow accounts
* on a regional or national level, and also the breakdown of cost of
* item or services.
*
* **Example:**
*
* [see doc](https://echarts.apache.org/en/option.html#series-sankey)
*
* **Visual Encoding:**
*
* The sankey graphs encodes each `node` of the raw data into a small
* rectangular.
* And different nodes are presented in different colors as far as possible.
* The `label` next to the small rectangular, which encoding the name
* of the node.
*
* In addition, the edge between two small rectangulars in the graph
* encoding the `link` of the raw data.
* The width of edge is shown proportionally to the `value` of `link`.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey
*/
interface SeriesSankey {
/**
* @default
* "sankey"
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.id
*/
id?: string | undefined;
/**
* Series name used for displaying in
* [tooltip](https://echarts.apache.org/en/option.html#tooltip)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.z
*/
z?: number | undefined;
/**
* Distance between sankey 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
* 5%
* @see https://echarts.apache.org/en/option.html#series-sankey.left
*/
left?: number | string | undefined;
/**
* Distance between sankey 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
* 5%
* @see https://echarts.apache.org/en/option.html#series-sankey.top
*/
top?: number | string | undefined;
/**
* Distance between sankey 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
* 20%
* @see https://echarts.apache.org/en/option.html#series-sankey.right
*/
right?: number | string | undefined;
/**
* Distance between sankey 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
* 5%
* @see https://echarts.apache.org/en/option.html#series-sankey.bottom
*/
bottom?: number | string | undefined;
/**
* Width of sankey component.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.width
*/
width?: number | string | undefined;
/**
* Height of sankey component.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.height
*/
height?: number | string | undefined;
/**
* The node width of rectangle in graph.
*
*
* @default
* 20
* @see https://echarts.apache.org/en/option.html#series-sankey.nodeWidth
*/
nodeWidth?: number | undefined;
/**
* The gap between any two rectangles in each column from the graph.
*
*
* @default
* 8
* @see https://echarts.apache.org/en/option.html#series-sankey.nodeGap
*/
nodeGap?: number | undefined;
/**
* Alignment of nodes in the graph.
*
* May be 'left', 'right' or 'justify'
*
* @default
* justify
* @see https://echarts.apache.org/en/option.html#series-sankey.nodeAlign
*/
nodeAlign?: string | undefined;
/**
* The iterations of layout, which is used to continuously optimize
* the positions of nodes in graph, decreasing the overlapping between
* nodes and edges.
*
* The default iterations of layout: `32`.
*
* The test shows that iterations of layout could not be less than
* the default value.
*
*
* @default
* 32
* @see https://echarts.apache.org/en/option.html#series-sankey.layoutIterations
*/
layoutIterations?: number | undefined;
/**
* The layout direction of the nodes in the Sankey diagram, which
* can be horizontal from left to right or vertical from top to
* bottom.
* The corresponding parameter values are `horizontal` or `vertical`.
*
*
* @default
* "horizontal"
* @see https://echarts.apache.org/en/option.html#series-sankey.orient
*/
orient?: string | undefined;
/**
* The drag-and-drop interaction of the node, which is enabled by
* default.
* After opening, the user can drag any node in the Sankey diagram
* to any position.
* To turn this interaction off, simply set the value to `false`.
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-sankey.draggable
*/
draggable?: boolean | undefined;
/**
* Support when mouse hovering over a node or an edge, the adjacent
* nodes and edges are also highlighted.
* Default off, can be manually opened.
*
* Optional values:
*
* + `false`: When hovering over a node or an edge, only the hovered
* node or edge is highlighted.
* + `true`: the same as `'allEdges'`.
* + `'allEdges'`: When hovering over a node, all of the adjacent
* edges and nodes are highlighted.
* When hovering over an edge, the adjacent nodes are highlighted.
* + `'outEdges'`: When hovering over a node, the outcoming edges
* and its adjacent nodes are highlighted.
* When hovering over an edge, the adjacent nodes are highlighted.
* + `'inEdges'`: When hovering over a node, the incoming edges
* and its adjacent nodes are highlighted.
* When hovering over an edge, the adjacent nodes are highlighted.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.focusNodeAdjacency
*/
focusNodeAdjacency?: boolean | string | undefined;
/**
* `label` describes the text label style in each rectangular node.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label
*/
label?: {
/**
* Whether to show label.
*
*
* @default
* "true"
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.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
* "right"
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.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-sankey.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-sankey.sankey.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.label.color
*/
color?: string | undefined;
/**
* font style
*
* Options are:
*
* + `'normal'`
* + `'italic'`
* + `'oblique'`
*
*
* @default
* "normal"
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.label.fontFamily
*/
fontFamily?: string | undefined;
/**
* font size
*
*
* @default
* 12
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.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-sankey.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-sankey.label.borderColor
*/
borderColor?: string | undefined;
/**
* Border width of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.borderWidth
*/
borderWidth?: number | undefined;
/**
* Border radius of the text fregment.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.label.padding
*/
padding?: any[] | number | undefined;
/**
* Shadow color of the text block.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-sankey.label.shadowColor
*/
shadowColor?: string | undefined;
/**
* Show blur of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow X offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text block.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.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-sankey.label.textBorderColor
*/
textBorderColor?: string | undefined;
/**
* Storke line width of the text.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.textBorderWidth
*/
textBorderWidth?: number | undefined;
/**
* Shadow color of the text itself.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-sankey.label.textShadowColor
*/
textShadowColor?: string | undefined;
/**
* Shadow blue of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.textShadowBlur
*/
textShadowBlur?: number | undefined;
/**
* Shadow X offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.textShadowOffsetX
*/
textShadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.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-sankey.label.rich
*/
rich?: {
/**
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.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-sankey.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-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily
*/
fontFamily?: string | undefined;
/**
* font size
*
*
* @default
* 12
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.label.rich.%3Cuser%20defined%20style%20name%3E)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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-sankey.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`).
*
* 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-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.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-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor
*/
textBorderColor?: string | undefined;
/**
* Storke line width of the text.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth
*/
textBorderWidth?: number | undefined;
/**
* Shadow color of the text itself.
*
*
* @default
* "transparent"
* @see https://echarts.apache.org/en/option.html#series-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor
*/
textShadowColor?: string | undefined;
/**
* Shadow blue of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur
*/
textShadowBlur?: number | undefined;
/**
* Shadow X offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX
*/
textShadowOffsetX?: number | undefined;
/**
* Shadow Y offset of the text itself.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY
*/
textShadowOffsetY?: number | undefined;
};
} | undefined;
} | undefined;
/**
* The style of node rectangle in sankey graphs.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.sankey.itemStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.itemStyle.color
*/
color?: EChartOption.Color | undefined;
/**
* border color, whose format is similar to that of `color`.
*
*
* @default
* "#aaa"
* @see https://echarts.apache.org/en/option.html#series-sankey.itemStyle.borderColor
*/
borderColor?: EChartOption.Color | undefined;
/**
* border width. No border when it is set to be 0.
*
*
* @default
* 1
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.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-sankey.sankey.itemStyle)
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.itemStyle.shadowBlur
*/
shadowBlur?: number | undefined;
/**
* Shadow color. Support same format as `color`.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.itemStyle.shadowColor
*/
shadowColor?: EChartOption.Color | undefined;
/**
* Offset distance on the horizontal direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.itemStyle.shadowOffsetX
*/
shadowOffsetX?: number | undefined;
/**
* Offset distance on the vertical direction of shadow.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.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-sankey.itemStyle.opacity
*/
opacity?: number | undefined;
} | undefined;
/**
* The line style of sankey graph, in which
* [lineStyle.color](https://echarts.apache.org/en/option.html#series-sankey.lineStyle.color)
* can be assigned to the value of `'source'` of `'target'`, then
* the edge will automatically take the source node or target node
* color as its own color.
*
*
* @see https://echarts.apache.org/en/option.html#series-sankey.lineStyle
*/
lineStyle?: {
/**
* The color of the edge in sankey graphs.
*
*
* @default
* "'#314656"
* @see https://echarts.apache.org/en/option.html#series-sankey.lineStyle.color
*/
color?: string | undefined;
/**
* The opacity of the edge in sankey graph.
*
*
* @default
* 0.2
* @see https://echarts.apache.org/en/option.html#series-sankey.lineStyle.opacity
*/
opacity?: number | undefined;
/**
* The curve