UNPKG

@types/echarts

Version:
1,158 lines (1,082 loc) 599 kB
declare namespace echarts { namespace EChartOption { /** * [Sunburst Chart](https://en.wikipedia.org/wiki/Pie_chart#Ring_chart_/_Sunburst_chart_/_Multilevel_pie_chart) * is composed of multiple pie charts. * From the view of data structure, inner rings are the parent nodes * of outer rings. * Therefore, it can show the partial-overall relationship as * [Pie](https://echarts.apache.org/en/option.html#series-pie) * charts, and also level relation as * [Treemap](https://echarts.apache.org/en/option.html#series-treemap) * charts. * * **For example:** * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst) * [see doc](https://echarts.apache.org/en/option.html#series-sunburst) * * **Data mining** * * Sunburst charts support data mining by default. * That means, when a user clicks a sector, it will be used as root * node, and there will be a circle in the center for return to parent * node. If data mining is not needed, it can be disabled by * [series-sunburst.nodeClick](https://echarts.apache.org/en/option.html#series-treemap.nodeClick) * . * * * @see https://echarts.apache.org/en/option.html#series-sunburst */ interface SeriesSunburst { /** * @default * "sunburst" * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.z */ z?: number | undefined; /** * Center position of Sunburst chart, 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:** * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst) * * * @default * ['50%', '50%'] * @see https://echarts.apache.org/en/option.html#series-sunburst.center */ center?: any[] | undefined; /** * Radius of Sunburst chart. Value can be: * * + `number`: Specify outside radius directly. * + `string`: For example, `'20%'`, means that the outside radius * is 20% of the viewport size (the little one between width and * height of the chart container). * + `Array.<number|string>`: * The first item specifies the inside radius, and the second item * specifies the outside radius. * Each item follows the definitions above. * * * @default * [0, '75%'] * @see https://echarts.apache.org/en/option.html#series-sunburst.radius */ radius?: any[] | number | string | undefined; /** * The data structure of * [series-sunburst.data](https://echarts.apache.org/en/option.html#series-sunburst.data) * is like tree. For example: * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.data */ data?: SeriesSunburst.DataObject[] | undefined; /** * `label` sets the text style for every sectors. * * **Priority: * [series.data.label](https://echarts.apache.org/en/option.html#series-sunburst.data.label) * > * [series.levels.label](https://echarts.apache.org/en/option.html#series-sunburst.levels.label) * > * [series.label](https://echarts.apache.org/en/option.html#series-sunburst.label) * .** * * 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-sunburst.label */ label?: { /** * If it is `number` type, then is stands for rotation, from * -90 degrees to 90 degrees, and positive values stand for * counterclockwise. * * Besides, it can be string `'radial'`, standing for radial * rotation; or `'tangential'`, standing for tangential rotation. * * By default, it is `'radial'`. * If no rotation is wanted, it can be set to `0`. * * The following example shows different `rotate` settings: * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst.label) * * * @default * "radial" * @see https://echarts.apache.org/en/option.html#series-sunburst.label.rotate */ rotate?: number | string | undefined; /** * Align of text, which can be `'left'`, `'center'`, or `'right'`. * Note that `'left'` stands for inner side, and `'right'` stands * for outer side. * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst.label) * * * @default * "center" * @see https://echarts.apache.org/en/option.html#series-sunburst.label.align */ align?: string | undefined; /** * If angle of data piece is smaller than this value (in degrees), * then text is not displayed. * This is used for hiding text for small piece of data. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.minAngle */ minAngle?: number | undefined; /** * Whether to show label. * * * @default * "true" * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.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-sunburst.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-sunburst.label.distance */ distance?: 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-sunburst.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. * + `{@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}: {@score}' * * ``` * * **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-sunburst.sunburst.label) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.label.color */ color?: string | undefined; /** * font style * * Options are: * * + `'normal'` * + `'italic'` * + `'oblique'` * * * @default * "normal" * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.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-sunburst.label.fontFamily */ fontFamily?: string | undefined; /** * font size * * * @default * 12 * @see https://echarts.apache.org/en/option.html#series-sunburst.label.fontSize */ fontSize?: number | 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-sunburst.sunburst.label) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.label) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.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-sunburst.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-sunburst.label.borderColor */ borderColor?: string | undefined; /** * Border width of the text fregment. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.borderWidth */ borderWidth?: number | undefined; /** * Border radius of the text fregment. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.label.padding */ padding?: any[] | number | undefined; /** * Shadow color of the text block. * * * @default * "transparent" * @see https://echarts.apache.org/en/option.html#series-sunburst.label.shadowColor */ shadowColor?: string | undefined; /** * Show blur of the text block. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.shadowBlur */ shadowBlur?: number | undefined; /** * Shadow X offset of the text block. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.shadowOffsetX */ shadowOffsetX?: number | undefined; /** * Shadow Y offset of the text block. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.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-sunburst.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-sunburst.label.textBorderColor */ textBorderColor?: string | undefined; /** * Storke line width of the text. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.textBorderWidth */ textBorderWidth?: number | undefined; /** * Shadow color of the text itself. * * * @default * "transparent" * @see https://echarts.apache.org/en/option.html#series-sunburst.label.textShadowColor */ textShadowColor?: string | undefined; /** * Shadow blue of the text itself. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.textShadowBlur */ textShadowBlur?: number | undefined; /** * Shadow X offset of the text itself. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.label.textShadowOffsetX */ textShadowOffsetX?: number | undefined; /** * Shadow Y offset of the text itself. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.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-sunburst.label.rich */ rich?: { /** * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily */ fontFamily?: string | undefined; /** * font size * * * @default * 12 * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.label.rich.%3Cuser%20defined%20style%20name%3E) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.label.rich.%3Cuser%20defined%20style%20name%3E) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.label.rich.%3Cuser%20defined%20style%20name%3E) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.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-sunburst.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY */ textShadowOffsetY?: number | undefined; }; } | undefined; } | undefined; /** * Style of Sunburst sectors. * * Style can be set in * [series.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.itemStyle) * for sectors of this series, or * [series.levels.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.levels.itemStyle) * for the whole level, or * [series.data.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.data.itemStyle) * for single sector. If * [series.data.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.data.itemStyle) * is defined, it will cover the setting of * [series.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.itemStyle) * and * [series.levels.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.levels.itemStyle) * . * * **Priority: * [series.data.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.data.itemStyle) * > * [series.levels.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.levels.itemStyle) * > * [series.itemStyle](https://echarts.apache.org/en/option.html#series-sunburst.itemStyle) * .** * * In ECharts, _emphasis_ is for styles when mouse hovers. * For Sunburst charts, there are two extra states: _highlight_ * for highlighting items that relates to the emphasized one, and * _downplay_ for others when emphasizing an item. See * [highlightPolicy](https://echarts.apache.org/en/option.html#series-sunburst.highlightPolicy) * . * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.sunburst.itemStyle) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.itemStyle.color */ color?: EChartOption.Color | undefined; /** * border color, whose format is similar to that of `color`. * * * @default * "white" * @see https://echarts.apache.org/en/option.html#series-sunburst.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-sunburst.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-sunburst.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-sunburst.sunburst.itemStyle) * * * @see https://echarts.apache.org/en/option.html#series-sunburst.itemStyle.shadowBlur */ shadowBlur?: number | undefined; /** * Shadow color. Support same format as `color`. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.itemStyle.shadowColor */ shadowColor?: EChartOption.Color | undefined; /** * Offset distance on the horizontal direction of shadow. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.itemStyle.shadowOffsetX */ shadowOffsetX?: number | undefined; /** * Offset distance on the vertical direction of shadow. * * * @see https://echarts.apache.org/en/option.html#series-sunburst.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. * * * @default * 1 * @see https://echarts.apache.org/en/option.html#series-sunburst.itemStyle.opacity */ opacity?: number | undefined; } | undefined; /** * When mouse hovers a sector, the sector is emphasized. * **If `highlightPolicy` is set to be `'descendant'`, then the * sector and its descendant will be _highlighted_, and others will * be _downplayed_. * If `highlightPolicy` is `'ancestor'`, then the sector and its * ancestors will be highlighted. * If it is set to be `'self'`, then the sector will be highlighted * and others downplayed. * If it is set to be `'none'`, then others will not be downplayed.** * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst) * * The `highlightPolicy` value above is the default value `'descendant'`. * We use `dispatchAction` to highlight certain sector. * Target sector will use the style of `emphasis`, and related sectors * decided by `highlightPolicy` uses the style of `highlight`, and * others use `downplay`. * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst) * * If `highlightPolicy` is set to be `'ancestor'`, then the result * looks like: * * [see doc](https://echarts.apache.org/en/option.html#series-sunburst.sunburst) * * * @default * "descendant" * @see https://echarts.apache.org/en/option.html#series-sunburst.highlightPolicy */ highlightPolicy?: string | undefined; /** * The action of clicking a sector, which can be: * * + `false`: nothing happens. * + `'rootToNode'`: use the clicked sector as root. * + `'link'`:if * [link](https://echarts.apache.org/en/option.html#series-sunburst.data.link) * is set, the page will redirect to it. * * * @default * "rootToNode" * @see https://echarts.apache.org/en/option.html#series-sunburst.nodeClick */ nodeClick?: boolean | string | undefined; /** * Sorting method that secto