diff --git a/.gitignore b/.gitignore index ac63b6f6b5..079ad27699 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,7 @@ npm-debug.log .settings/launch.json .vs .vscode +.history # yarn yarn.lock diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts index dc525231e6..207b8366ef 100644 --- a/types/echarts/index.d.ts +++ b/types/echarts/index.d.ts @@ -4,9 +4,12 @@ // AntiMoron // Liveangela // Ovilia +// Roman // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 +/// + declare namespace echarts { /** * Creates an ECharts instance, and returns an echartsInstance. You shall @@ -138,6 +141,11 @@ declare namespace echarts { const graphic: Graphic; interface Graphic { + /** + * x, y, x2, y2 are all percent from 0 to 1 + */ + LinearGradient: zrender.LinearGradient; + /** * Clip the given points by the given rectangular. * @@ -433,56 +441,478 @@ declare namespace echarts { height: number } - interface EChartOption { + type EChartsSeriesType = ( + 'line' | 'bar' | 'pie' | 'scatter' | 'effectScatter' | 'radar' + | 'tree' | 'treemap' | 'sunburst' | 'boxplot' | 'candlestick' + | 'heatmap' | 'map' | 'parallel' | 'lines' | 'graph' | 'sankey' + | 'funnel' | 'gauge' | 'pictorialBar' | 'themeRiver' | 'custom' + ); + + interface EChartOption { + /** + * Title component, including main title and subtitle. + * In ECharts 2.x, a single instance of ECharts could contains + * one title component at most. + * However, in ECharts 3, there could be one or more + * than one title components. + * It is more useful when multiple diagrams in one instance all need titles. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#title + */ title?: EChartTitleOption + + /** + * Legend component. + * Legend component shows symbol, color and name of different series. + * You can click legends to toggle displaying series in the chart. + * In ECharts 3, a single echarts instance may contain multiple + * legend components, which makes it easier for the layout of multiple + * legend components. + * If there have to be too many legend items, `vertically scrollable` legend + * or `horizontally scrollable` legend are options to paginate them. + * Check `legend.type` please. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#legend + */ legend?: object, + + /** + * Drawing grid in rectangular coordinate. + * In a single grid, at most two X and Y axes each is allowed. + * `Line chart`, `bar chart`, and `scatter chart (bubble chart)` + * can be drawn in grid. + * In ECharts 2.x, there could only be one single grid component + * at most in a single echarts instance. + * But in ECharts 3, there is no limitation. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#grid + */ grid?: object, - xAxis?: object, - yAxis?: object, + + /** + * The x axis in cartesian(rectangular) coordinate. + * Usually a single grid component can place at most 2 x axis, + * one on the bottom and another on the top. + * offset can be used to avoid overlap when you need to put more + * than two x axis. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis + */ + xAxis?: EChartOption.XAxis | EChartOption.XAxis[], + + /** + * The y axis in cartesian(rectangular) coordinate. + * Usually a single grid component can place at most 2 y axis, + * one on the left and another on the right. offset can be used + * to avoid overlap when you need to put more than two y axis. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis + */ + yAxis?: EChartOption.YAxis | EChartOption.YAxis[], + + /** + * Polar coordinate can be used in scatter and line chart. + * Every polar coordinate has an `angleAxis` and a `radiusAxis`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#polar + */ polar?: object, + + /** + * Radial axis of polar coordinate. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis + */ radiusAxis?: object, + + /** + * The angle axis in Polar Coordinate. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#angleAxis + */ angleAxis?: object, + + /** + * Coordinate for `radar charts`. + * This component is equal to the polar component in ECharts 2. + * Because the polar component in the echarts 3 is reconstructed + * to be the standard polar coordinate component, + * this component is renamed to be radar to avoid confusion. + * Radar chart coordinate is different from polar coordinate, + * in that every axis indicator of the radar chart coordinate + * is an individual dimension. + * The style of indicator coordinate axis could be configured + * through the following configuration items, + * including `name`, `axisLine`, `axisTick`, `axisLabel`, + * `splitLine`, `splitArea`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#radar + */ radar?: object, - dataZoom?: object[], + + /** + * `dataZoom` component is used for zooming a specific area, + * which enables user to investigate data in detail, + * or get an overview of the data, + * or get rid of outlier points. + * These types of `dataZoom` component are supported: + * + `dataZoomInside`: Data zoom functionalities is embeded + * inside coordinate systems, enable user to zoom + * or roam coordinate system by mouse dragging, + * mouse move or finger touch (in touch screen). + * + `dataZoomSlider`: A special slider bar is provided, + * on which coordinate systems can be zoomed or roamed + * by mouse dragging or finger touch (in touch screen). + * + `dataZoomSelect`: A marquee tool is provided for zooming + * or roaming coordinate system. + * That is `toolbox.feature.dataZoom`, which can only be configured + * in toolbox. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom + */ + dataZoom?: EChartOption.DataZoom[], + + /** + * `visualMap` is a type of component for visual encoding, + * which maps the data to visual channels, including: + * + symbol: Type of symbol. + * + symbolSize: Symbol size. + * + color: Symbol color. + * + colorAlpha: Symbol alpha channel. + * + opacity: Opacity of symbol and others (like labels). + * + colorLightness: Lightness in HSL. + * + colorSaturation: Saturation in HSL. + * + colorHue: Hue in HSL. + * Myltiple `visualMap` component could be defined in a chart instance, + * which enable that different dimensions + * of a series data are mapped to different visual channels. + * `visualMap` could be defined as `Piecewise (visualMapPiecewise)` + * or `Continuous (visualMapContinuous)`, + * which is distinguished by the property type. + * + * @example + * option = { + * visualMap: [ + * { // the first visualMap component + * type: 'continuous', // defined to be continuous viusalMap + * ... + * }, + * { // the sencond visualMap component + * type: 'piecewise', // defined to be piecewise visualMap + * ... + * } + * ], + * ... + * }; + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap + */ visualMap?: object[], - tooltip?: object, - axisPointer?: object, + + /** + * Tooltip component. + * It can be configured on different places: + * + Configured on global: `tooltip` + * + Configured in a coordinate system: `grid.tooltip`, + * `polar.tooltip`, `single.tooltip` + * + Configured in a series: `series.tooltip` + * + Configured in each item of `series.data`: `series.data.tooltip` + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip + */ + tooltip?: EChartOption.Tooltip, + + /** + * `axisPointer` is a tool for displaying reference line and axis value + * under mouse pointer. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#axisPointer + */ + axisPointer?: EChartOption.AxisPointer, + + /** + * A group of utility tools, which includes `export`, `data view`, + * `dynamic type switching`, `data area zooming`, and `reset`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#toolbox + */ toolbox?: object, + + /** + * `brush` is an area-selecting component, with which user can select + * part of data from a chart to display in detail, or doing calculations + * with them. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#brush + */ brush?: object, + + /** + * Geographic coorinate system component. + * Geographic coorinate system component is used to draw maps, + * which also supports `scatter series`, and `line series`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#geo + */ geo?: object, + + /** + * `Parallel Coordinates` is a common way of visualizing high-dimensional + * geometry and analyzing multivariate data. + * For example, `series-parallel.data` is the following data: + * + * @example + * [ + * [1, 55, 9, 56, 0.46, 18, 6, 'good'], + * [2, 25, 11, 21, 0.65, 34, 9, 'excellent'], + * [3, 56, 7, 63, 0.3, 14, 5, 'good'], + * [4, 33, 7, 29, 0.33, 16, 6, 'excellent'], + * { // Data item can also be an Object, + * // so that perticular settings of its line can be set here. + * value: [5, 42, 24, 44, 0.76, 40, 16, 'excellent'] + * lineStyle: {...}, + * } + * ... + * ] + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#parallel + */ parallel?: object, + + /** + * This component is the coordinate axis for parallel coordinate. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#parallelAxis + */ parallelAxis?: object, + + /** + * An axis with a single dimension. It can be used to display data + * in one dimension. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#singleAxis + */ singleAxis?: object, + + /** + * `timeline` component, which provides functions like switching and playing + * between multiple ECharts `options`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#timeline + */ timeline?: object, + + /** + * `graphic` component enable creating graphic elements in echarts. + * Those graphic type are supported. + * `image`, `text`, `circle`, `sector`, `ring`, `polygon`, + * `polyline`, `rect`, `line`, `bezierCurve`, `arc`, `group`, + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#graphic + */ graphic?: object | object[], + + /** + * Calendar coordinates. + * In ECharts, we are very creative to achieve the calendar chart, + * by using the calendar coordinates + * to achieve the calendar chart, as shown in the following example, + * we can use calendar coordinates + * in `heatmap`, `scatter`, `effectScatter`, and `graph`. + + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#calendar + */ calendar?: object, + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset + */ dataset?: object, + + /** + * `dataset` component is published since ECharts 4. + * `dataset` brings convenience in data management separated with styles + * and enables data reuse by different series. + * More importantly, is enables data encoding from data to visual, + * which brings convenience in some scenarios. + * More details about `dataset` can be checked in the tutorial. + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#aria + */ aria?: object, - series?: object[], + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series + */ + series?: TSeries[], + + /** + * The color list of palette. + * If no color is set in series, the colors would be adopted sequentially + * and circularly from this list + * as the colors of series. + * @default + * [ + * '#c23531','#2f4554','#61a0a8','#d48265','#91c7ae', + * '#749f83', '#ca8622','#bda29a','#6e7074','#546570', + * '#c4ccd3' + * ] + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#color + */ color?: string[], + + /** + * Background color. Defaults to have no background. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#backgroundColor + */ backgroundColor?: string, - textStyle?: object, + + /** + * Global font style. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#textStyle + */ + textStyle?: EChartOption.TextStyle, + + /** + * Whether to enable animation. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animation + */ animation?: boolean, + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than threshold. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationThreshold + */ animationThreshold?: number, + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect + * + * @example + * animationDuration: function (idx) { + * // delay for later data is larger + * return idx * 100; + * } + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationDuration + */ animationDuration?: number, + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at `easing effect example`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationEasing + */ animationEasing?: string, + + /** + * Delay before updating the first animation, which supports + * callback function for different data + * to have different animation effect. + * + * @example + * animationDelay: function (idx) { + * // delay for later data is larger + * return idx * 100; + * } + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationDelay + */ animationDelay?: number | Function, + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect + * + * @example + * animationDurationUpdate: function (idx) { + * // delay for later data is larger + * return idx * 100; + * } + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationDurationUpdate + */ animationDurationUpdate?: number | Function, + + /** + * Easing method used for animation. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationEasingUpdate + */ animationEasingUpdate?: string, + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * @example + * animationDelayUpdate: function (idx) { + * // delay for later data is larger + * return idx * 100; + * } + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#animationDelayUpdate + */ animationDelayUpdate?: number | Function, + + /** + * Configuration for progressive/incremental rendering + * + * @default 400 + */ progressive?: number, + + /** + * Configuration for progressive/incremental rendering + * + * @default 3000 + */ progressiveThreshold?: number, + + /** + * Equal to CanvasRenderingContext2D.globalCompositeOperation + * + * @see https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation + * + */ blendMode?: string, + + /** + * Threshold of if use single hover layer to optimize. + * It is recommended that `hoverLayerThreshold` is equivalent to or less than + * `progressiveThreshold`, otherwise hover will cause restart of progressive, + * which is unexpected. + * see example . + * + * @default 3000 + */ hoverLayerThreshold?: number, + + /** + * Whether to use UTC in display. + * - `true`: When `axis.type` is `'time'`, ticks is determined + * according to UTC, and `axisLabel` and `tooltip` use UTC by default. + * - `false`: When `axis.type` is `'time'`, ticks is determined + * according to local time, and `axisLabel` and `tooltip` use local time + * by default. + * + * The default value of useUTC is false, for sake of considering: + * - In many cases, labels should be displayed in local time + * (whether the time is stored in server in local time or UTC). + * - If user uses time string (like '2012-01-02') in data, + * it usually means local time if time zone is not specified. + * Time should be displayed in its original time zone by default. + * + * Notice: the setting only effects 'display time', but not 'parse time'. + * About how time value (like `1491339540396`, `'2013-01-04'`, ...) + * is parsed in echarts, see `the time part in date`. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#useUTC + */ useUTC?: boolean, - /** echarts-gl options */ - globe?: object, - geo3D?: object, - mapbox3D?: object, - grid3D?: object, - xAxis3D?: object, - yAxis3D?: object, - zAxis3D?: object } interface EChartsOptionConfig { @@ -566,6 +996,580 @@ declare namespace echarts { */ zlevel?: 0 } + + namespace EChartOption { + type Series = ( + SeriesLine + | SeriesBar + | SeriesPie + | SeriesScatter + | SeriesEffectScatter + | SeriesRadar + | SeriesTree + | SeriesTreemap + | SeriesSunburst + | SeriesBoxplot + | SeriesCandlestick + | SeriesHeatmap + | SeriesMap + | SeriesParallel + | SeriesLines + | SeriesGraph + | SeriesSankey + | SeriesFunnel + | SeriesGauge + | SeriesPictorialBar + | SeriesThemeRiver + | SeriesCustom + ) + + namespace BasicComponents { + /** + * @todo describe + */ + interface Line { + show?: boolean; + onZero?: boolean; + onZeroAxisIndex?: number; + symbol?: string | string[]; + symbolSize?: number[]; + symbolOffset?: number[]; + lineStyle?: { + color?: string; + width?: number; + type?: 'solid' | 'dashed' | 'dotted'; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + } + + interface CartesianAxis { + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option or API. + */ + id?: string; + + /** + * If show this axis. + * + * @default 'true' + */ + show?: boolean; + + /** + * The index of grid which this axis belongs to. + * Defaults to be in the first grid. + * + * @default 0 + */ + gridIndex?: number; + + /** + * Offset of this axis relative to default position. + * Useful when multiple axis of this type has same position value. + * + * @default 0 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.offset + */ + offset?: number; + + /** + * Name of axis. + */ + name?: string; + + /** + * Location of axis name. + * + * @default 'start' + */ + nameLocation?: 'start' | 'middle' | 'center' | 'end'; + + /** + * Text style of axis name. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.nameTextStyle + */ + nameTextStyle?: CartesianAxis.TextStyle; + + /** + * Gap between axis name and axis line. + * + * @default 15 + */ + nameGap?: number; + + /** + * Rotation of axis name. + * + * @default null + */ + nameRotate?: number; + + /** + * Whether axis is inversed. New option from ECharts 3. + * + * @default false + */ + inverse?: boolean; + + /** + * The boundary gap on both sides of a coordinate axis. + * The setting and behavior of category axes and non-category axes are + * different. The `boundaryGap` of category axis can be set to either + * `true` or `false`. Default value is set to be `true`, in which case + * `axisTick` is served only as a separation line, and labels and data + * appear only in the center part of two axis ticks, which is called + * band. For non-category axis, including time, numerical value, and + * log axes, `boundaryGap` is an array of two values, representing the + * spanning range between minimum and maximum value. + * The value can be set in numeric value or relative percentage, + * which becomes invalid after setting `min` and `max`. + * + * @example + * boundaryGap: ['20%', '20%'] + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.boundaryGap + */ + boundaryGap?: boolean | (string | number)[]; + + /** + * The minimun value of axis. + * It can be set to a special value `'dataMin'` so that + * the minimum value on this axis is set to be the minimum label. + * It will be automatically computed to make sure axis tick is equally + * distributed when not set. In category axis, it can also be set + * as the ordinal number. + * For example, if a catergory axis has + * `data: ['categoryA', 'categoryB', 'categoryC']` + * , and the ordinal `2` represents `'categoryC'`. + * Moreover, it can be set as negative number, like `-3`. + * + * @default null + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.min + */ + min?: number | string; + + /** + * The maximum value of axis. + * It can be set to a special value `'dataMax'` so that + * the minimum value on this axis is set to be the maximum label. + * It will be automatically computed to make sure axis tick is equally + * distributed when not set. + * In category axis, it can also be set as the ordinal number. + * For example, if a catergory axis has + * `data: ['categoryA', 'categoryB', 'categoryC']` + * , and the ordinal `2` represents `'categoryC'`. + * Moreover, it can be set as negative number, like `-3`. + * + * @default null + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.max + */ + max?: number | string; + + /** + * It is available only in numerical axis, i.e., type: `'value'`. + * It specifies whether not to contain zero position + * of axis compulsively. + * When it is set to be `true`, the axis may not contain zero position, + * which is useful in the scatter chart for both value axes. + * This configuration item is unavailable when the `min` and `max` + * are set. + * + * @default false + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.scale + */ + scale?: boolean; + + /** + * Number of segments that the axis is split into. + * Note that this number serves only as a recommendation, + * and the true segments may be adjusted based on readability. + * This is unavailable for category axis. + * + * @default 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.splitNumber + */ + splitNumber?: number; + + /** + * Maximum gap between split lines. + * For example, in time axis (type is `'time'`), + * it can be set to be `3600 * 24 * 1000` to make sure + * that the gap between axis labels is less than or equal to one day. + * @example + * { + * maxInterval: 3600 * 1000 * 24 + * } + * It is available only for axis of type `'value'` or `'time'`. + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.minInterval + */ + minInterval?: any; + + /** + * Compulsively set segmentation interval for axis. + * As splitNumber is a recommendation value, + * the calculated tick may not be the same as expected. + * In this case, interval should be used along with min and max + * to compulsively set tickings. + * But in most cases, we do not suggest using this, + * out automatic calculation is enough for most situations. + * This is unavailable for category axis. + * Timestamp should be passed for type: `'time'` axis. + * Logged value should be passed for type: `'log'` axis. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.interval + */ + interval?: number; + + /** + * Base of logarithm, which is valid only for numeric axes with type: + * `'log'`. + * + * @default 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.logBase + */ + logBase?: number; + + /** + * True for axis that cannot be interacted with. + * + * @default false + */ + silent?: boolean; + + /** + * Whether the labels of axis triggers and reacts to mouse events. + * Parameters of event includes: + * + * @example + * { + * // Component type: xAxis, yAxis, radiusAxis, angleAxis + * // Each of which has an attribute for index, e.g., xAxisIndex for xAxis + * componentType: string, + * // Value on axis before being formatted. + * // Click on value label to trigger event. + * value: '', + * // Name of axis. + * // Click on laben name to trigger event. + * name: '' + * } + * + * @default false + */ + triggerEvent?: boolean; + + /** + * Settings related to axis line. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisLine + */ + axisLine?: Line; + + /** + * Settings related to axis tick. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisTick + */ + axisTick?: CartesianAxis.Tick; + + /** + * Settings related to axis label. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisLabel + */ + + axisLabel?: CartesianAxis.Label; + + /** + * SplitLine of axis in grid area. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.splitLine + */ + + splitLine?: CartesianAxis.SplitLine; + + /** + * Split area of axis in grid area, not shown by default. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.splitArea + */ + splitArea?: CartesianAxis.SplitArea; + + /** + * Category data, available in type: `'category'` axis. + * If `type` is not specified, but `axis.data` is specified, + * the `type` is auto set as `'category'`. + * If type is specified as `'category'`, + * but axis.data is not specified, `axis.data` will be + * auto collected from `series.data`. + * It brings convenience, but we should notice that + * `axis.data` provides then value range of the `'category'` axis. + * If it is auto collected from `series.data`, + * Only the values appearing in series.data can be collected. + * For example, if series.data is empty, nothing will be collected. + * + * @example + * // Name list of all categories + * data: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] + * // Each item could also be a specific configuration item. + * // In this case, `value` is used as the category name. + * data: [{ + * value: 'Monday', + * // Highlight Monday + * textStyle: { + * fontSize: 20, + * color: 'red' + * } + * }, 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.data + */ + data?: (string | CartesianAxis.DataObject)[]; + + /** + * axisPointer settings on the axis. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisPointer + */ + axisPointer?: CartesianAxis.Pointer; + + /** + * `zlevel` value of all graghical elements in this axis. + * `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`. + * + * @default 0 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.zlevel + */ + zlevel?: number; + + /** + * z value of all graghical elements in this axis, + * 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. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.z + */ + z?: number; + } + + namespace CartesianAxis { + type Type = 'value' | 'category' | 'time' | 'log'; + + /** + * @todo describe + */ + interface Style { + color?: string; + fontStyle?: 'normal' | 'italic' | 'oblique'; + fontWeight?: 'normal' | 'bold' | 'bolder' | 'lighter' + | '100' | '200' | '300' | '400'; + fontFamily?: string; + fontSize?: number; + align?: string; + verticalAlign?: string; + lineHeight?: number; + backgroundColor?: string | object; + borderColor?: string; + borderWidth?: number; + borderRadius?: number; + padding?: number | number[]; + shadowColor?: string; + shadowBlur?: number; + shadowOffsetX?: number; + shadowOffsetY?: number; + width?: number | string; + height?: number | string; + textBorderColor?: string; + textBorderWidth?: number; + textShadowColor?: string; + textShadowBlur?: number; + textShadowOffsetX?: number; + textShadowOffsetY?: number; + } + + /** + * @todo describe + */ + interface RichStyle { + [userStyleName: string]: Style; + } + + interface TextStyle extends Style { + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.data.textStyle.rich + */ + rich?: RichStyle; + } + + /** + * @todo describe + */ + interface Tick { + show?: boolean; + alignWithLabel?: boolean; + interval?: number | Function; + inside?: boolean; + length?: number; + lineStyle?: { + color?: string; + width?: number; + type?: 'solid' | 'dashed' | 'dotted'; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + } + + /** + * @todo describe + */ + interface Label extends TextStyle { + show?: boolean; + interval?: number | Function; + inside?: boolean; + rotate?: number; + margin?: number; + formatter?: string | Function; + showMinLabel?: boolean; + showMaxLabel?: boolean; + } + + /** + * @todo describe + */ + interface SplitLine { + show?: boolean; + interval?: number | Function; + lineStyle?: { + color?: string | string[]; + width?: number; + type?: 'solid' | 'dashed' | 'dotted'; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + } + + /** + * @todo describe + */ + interface SplitArea { + interval?: number | Function; + show?: boolean; + areaStyle?: { + color?: string[]; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + } + + /** + * @todo describe + */ + interface DataObject { + value?: string; + textStyle?: TextStyle; + } + + /** + * @todo describe + */ + interface Pointer { + show?: boolean; + type?: 'line' | 'shadow' | 'none'; + snap?: boolean; + z?: number; + label?: PointerLabel; + lineStyle?: { + color?: string; + width?: number; + type?: string; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + shadowStyle?: { + color?: string; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + opacity?: number; + }; + triggerTooltip?: boolean; + value?: number; + status?: boolean; + handle?: { + show?: boolean; + icon?: any; + size?: number | number[]; + margin?: number; + color?: string; + throttle?: number; + shadowBlur?: number; + shadowColor?: string; + shadowOffsetX?: number; + shadowOffsetY?: number; + }; + } + + interface PointerLabel { + show?: boolean; + precision?: number | string; + formatter?: string | Function; + margin?: boolean; + color?: string; + fontStyle?: 'normal' | 'italic' | 'oblique'; + fontWeight?: 'normal' | 'bold' | 'bolder' | 'lighter' + | '100' | '200' | '300' | '400'; + fontFamily?: string; + fontSize?: number; + lineHeight?: number; + backgroundColor?: string | object; + borderColor?: string; + borderWidth?: number; + borderRadius?: number; + padding?: number | number[]; + shadowColor?: string; + shadowBlur?: number; + shadowOffsetX?: number; + shadowOffsetY?: number; + width?: number | string; + height?: number | string; + textBorderColor?: string; + textBorderWidth?: number; + textShadowColor?: string; + textShadowBlur?: number; + textShadowOffsetX?: number; + textShadowOffsetY?: number; + } + } + } + } } declare module 'echarts' { diff --git a/types/echarts/options/axis-pointer.d.ts b/types/echarts/options/axis-pointer.d.ts new file mode 100644 index 0000000000..2e060b1c96 --- /dev/null +++ b/types/echarts/options/axis-pointer.d.ts @@ -0,0 +1,64 @@ +declare namespace echarts { + namespace EChartOption { + /** + * @todo describe + */ + interface AxisPointer extends BasicComponents.CartesianAxis.Pointer { + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component + * in option or API. + */ + id?: string; + + /** + * axisPointers can be linked to each other. + * The term 'link' represents that axes are synchronized + * and move together. + * Axes are linked according to the value of axisPointer. + * See + * [sampleA](https://ecomfe.github.io/echarts-examples/public/view.html?c=candlestick-brush&edit=1&reset=1) + * and + * [sampleB](https://ecomfe.github.io/echarts-examples/public/view.html?c=scatter-nutrients-matrix&edit=1&reset=1). + * link is an array, where each item represents a 'link group'. + * Axes will be linked when they are refered + * in the same link group. + * + * @example: + * link: [ + * { + * // All axes with xAxisIndex 0, 3, 4 and yAxisName 'sameName' will be linked. + * xAxisIndex: [0, 3, 4], + * yAxisName: 'someName' + * }, + * { + * // All axes with xAxisId 'aa', 'cc' and all angleAxis will be linked. + * xAxisId: ['aa', 'cc'], + * angleAxis: 'all' + * }, + * ... + * ] + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#axisPointer.link + */ + link?: object[]; + + /** + * Conditions to trigger tooltip. + * Options: + * + `'mousemove'` - Trigger when mouse moves. + * + `'click'` - Trigger when mouse clicks. + * + `'mousemove|click'` - Trigger when mouse clicks and moves. + * `'none'` - Do not triggered by `'mousemove'` and `'click'`. + * Tooltip can be triggered and hidden manually by calling + * `action.tooltip.showTip` and `action.tooltip.hideTip`. + * It can also be triggered by `axisPointer.handle` in this case. + * + * This attribute is new to ECharts 3.0. + * + * @default 'mousemove|click' + */ + triggerOn?: 'mousemove' | 'click' | 'mousemove|click' | 'none'; + } + } +} diff --git a/types/echarts/options/data-zoom.d.ts b/types/echarts/options/data-zoom.d.ts new file mode 100644 index 0000000000..2ed18582ef --- /dev/null +++ b/types/echarts/options/data-zoom.d.ts @@ -0,0 +1,106 @@ +declare namespace echarts { + namespace EChartOption { + /** + * Data zoom component of inside type. + * Refer to dataZoom for more information. + * The inside means it's inside the coordinates. + * Translation: data area can be translated when moving in coordinates. + * Scaling: + * PC: when mouse rolls (similar with touch pad) in coordinates. + * Mobile: when touches and moved with two fingers in coordinates + * on touch screens. + * + * @todo describe + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom-inside + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom-slider + */ + type DataZoom = DataZoom.Inside + | DataZoom.Slider; + + namespace DataZoom { + /** + * Data zoom component of inside type. + * Refer to dataZoom for more information. + * The inside means it's inside the coordinates. + * Translation: data area can be translated when moving in coordinates. + * Scaling: + * PC: when mouse rolls (similar with touch pad) in coordinates. + * Mobile: when touches and moved with two fingers in coordinates + * on touch screens. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom-inside + */ + interface Inside { + type?: string; + id?: string; + disable?: boolean; + xAxisIndex?: number | number[]; + yAxisIndex?: number | number[]; + radiusAxisIndex?: number | number[]; + angleAxisIndex?: number | number[]; + filterMode?: 'filter' | 'weakFilter' | 'empty' | 'none'; + start?: number; + end?: number; + startValue?: number | string | Date; + endValue?: number | string | Date; + minSpan?: number; + maxSpan?: number; + minValueSpan?: number | string | Date; + maxValueSpan?: number | string | Date; + orient?: string; + zoomLock?: boolean; + throttle?: number; + rangeMode?: string[]; + zoomOnMouseWheel?: boolean; + moveOnMouseMove?: boolean; + moveOnMouseWheel?: boolean; + preventDefaultMouseMove?: boolean; + } + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom-slider + */ + interface Slider { + type?: string; + id?: string; + show?: boolean; + backgroundColor?: string; + dataBackground?: object; + fillColor?: string; + borderColor?: string; + handleIcon?: string; + handleSize?: number; + handleStyle?: object; + labelPrecision?: number; + labelFormatter?: string | Function; + showDetail?: boolean; + showDataShadow?: string; + realtime?: boolean; + textStyle?: object; + xAxisIndex?: number | number[]; + yAxisIndex?: number | number[]; + radiusAxisIndex?: number | number[]; + angleAxisIndex?: number | number[]; + filterMode?: 'filter' | 'weakFilter' | 'empty' | 'none'; + start?: number; + end?: number; + startValue?: number | string | Date; + endValue?: number | string | Date; + minSpan?: number; + maxSpan?: number; + minValueSpan?: number | string | Date; + maxValueSpan?: number | string | Date; + orient?: 'vertical' | 'horizontal'; + zoomLock?: boolean; + throttle?: number; + rangeMode?: string[]; + zlevel?: number; + z?: number; + left?: string | number; + top?: string | number; + right?: string | number; + bottom?: string | number; + } + } + } +} diff --git a/types/echarts/options/series/bar.d.ts b/types/echarts/options/series/bar.d.ts new file mode 100644 index 0000000000..3116f87d53 --- /dev/null +++ b/types/echarts/options/series/bar.d.ts @@ -0,0 +1,16598 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **bar chart** + * + * Bar chart shows different data through the height of a bar, which + * is used in + * [rectangular coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * with at least 1 category axis. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar + */ + interface SeriesBar { + /** + * @default + * "bar" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.type + */ + type?: 'bar'; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.yAxisIndex) + * to assign the corresponding axis component. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.yAxisIndex + */ + yAxisIndex?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label + */ + label?: { + /** + * Some properties like "normal" or "emphasis" are not documented. + * Please, write description for them + */ + [unknownProperty: string]: any; + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally and + * move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle + */ + itemStyle?: { + /** + * Some properties like "normal" or "emphasis" are not documented. + * Please, write description for them + */ + [unknownProperty: string]: any; + + /** + * Bar color. defaults to acquire colors from global palette + * [option.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#color) + * . + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.barBorderWidth + */ + barBorderWidth?: number; + + /** + * The radius of rounded corner. + * Its unit is px. + * And it supports use array to respectively specify the 4 corner + * radiuses. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.barBorderRadius + */ + barBorderRadius?: any[] | number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle + */ + itemStyle?: { + + /** + * Bar color.. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.barBorderWidth + */ + barBorderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * Name of stack. + * On the same category axis, the series with the same `stack` name + * would be put on top of each other. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.stack + */ + stack?: string; + + /** + * The mouse style when mouse hovers on an element, the same as + * `cursor` property in `CSS`. + * + * + * @default + * "pointer" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.cursor + */ + cursor?: string; + + /** + * The width of the bar. Adaptive when not specified. + * + * In a single coodinate system, this attribute is shared by multiple + * `'bar'` series. + * This attribute should be set on the last `'bar'` series in the + * coodinate system, then it will be adopted by all `'bar'` series + * in the coordinate system. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.barWidth + */ + barWidth?: number; + + /** + * The maximum width of the bar. Adaptive when not specified. + * + * In a single coodinate system, this attribute is shared by multiple + * `'bar'` series. + * This attribute should be set on the last `'bar'` series in the + * coodinate system, then it will be adopted by all `'bar'` series + * in the coordinate system. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.barMaxWidth + */ + barMaxWidth?: number; + + /** + * The minimum width of bar. + * It could be used to avoid the following situation: the interaction + * would be affected when the value of some data item is too small. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.barMinHeight + */ + barMinHeight?: number; + + /** + * The gap between bars between different series, is a percent value + * like `'30%'`, which means `30%` of the bar width. + * + * Set barGap as `'-100%'` can overlap bars that belong to different + * series, which is useful when making a series of bar be background. + * + * In a single coodinate system, this attribute is shared by multiple + * `'bar'` series. + * This attribute should be set on the last `'bar'` series in the + * coodinate system, then it will be adopted by all `'bar'` series + * in the coordinate system. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * + * @default + * 30% + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.barGap + */ + barGap?: string; + + /** + * The bar gap of a single series, defaults to be `20%` of the category + * gap, can be set as a fixed value. + * + * In a single coodinate system, this attribute is shared by multiple + * `'bar'` series. + * This attribute should be set on the last `'bar'` series in the + * coodinate system, then it will be adopted by all `'bar'` series + * in the coordinate system. + * + * + * @default + * '20%' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.barCategoryGap + */ + barCategoryGap?: string; + + /** + * Whether to enable the optimization of large-scale data. + * It could be set when large data causes performance problem. + * + * After being enabled, `largeThreshold` can be used to indicate + * the minimum number for turning on the optimization. + * + * But when the optimization enabled, the style of single data item + * can't be customized any more. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.large + */ + large?: boolean; + + /** + * The threshold enabling the drawing optimization. + * + * + * @default + * 400 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.largeThreshold + */ + largeThreshold?: number; + + /** + * `progressive` specifies the amount of graphic elements that can + * be rendered within a frame (about 16ms) if "progressive rendering" + * enabled. + * + * When data amount is from thousand to more than 10 million, it + * will take too long time to render all of the graphic elements. + * Since ECharts 4, "progressive rendering" is supported in its + * workflow, which processes and renders data chunk by chunk alone + * with each frame, avoiding to block the UI thread of the browser. + * + * + * @default + * 5000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.progressive + */ + progressive?: number; + + /** + * If current data amount is over the threshold, "progressive rendering" + * is enabled. + * + * + * @default + * 3000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.progressiveThreshold + */ + progressiveThreshold?: number; + + /** + * Chunk approach, optional values: + * + * + `'sequential'`: slice data by data index. + * + `'mod'`: slice data by mod, which make the data items of each + * chunk coming from all over the data, bringing better visual effect + * while progressive rendering. + * + * + * @default + * "mod" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.progressiveChunkMode + */ + progressiveChunkMode?: string; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.encode + */ + encode?: object; + + /** + * When + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, `seriesLayoutBy` specifies whether the column or the + * row of `dataset` is mapped to the series, namely, the series + * is "layout" on columns or rows. Optional values: + * + * + 'column': by default, the columns of `dataset` are mapped the + * series. In this case, each column represents a dimension. + * + 'row'：the rows of `dataset` are mapped to the series. + * In this case, each row represents a dimension. + * + * Check this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=dataset-series-layout-by) + * . + * + * + * @default + * "column" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.seriesLayoutBy + */ + seriesLayoutBy?: string; + + /** + * If + * [series.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * is not specified, and + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * exists, the series will use `dataset`. + * `datasetIndex` specifies which dataset will be used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.datasetIndex + */ + datasetIndex?: number; + + /** + * Data array of series, which can be in the following forms: + * + * Notice, if no `data` specified in series, and there is + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * in option, series will use the first + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * as its datasource. If `data` has been specified, + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * will not used. + * + * `series.datasetIndex` can be used to specify other + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * . + * + * Basically, data is represented by a two-dimension array, like + * the example below, where each colum is named as a "dimension". + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * + In + * [cartesian (grid)](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , "dimX" and "dimY" correspond to + * [xAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * and + * [yAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * repectively. + * + In + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * "dimX" and "dimY" correspond to + * [radiusAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis) + * 和 + * [angleAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#anbleAxis) + * repectively. + * + Other dimensions are optional, which can be used in other place. + * For example: + * + [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * can map one or more dimensions to viusal (color, symbol size + * ...). + * + [series.symbolSize](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.symbolSize) + * can be set as a callback function, where symbol size can be calculated + * by values of a certain dimension. + * + Values in other dimensions can be shown by + * [tooltip.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.formatter) + * or + * [series.label.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.label.formatter) + * . + * + * Especially, when there is one and only one category axis (axis.type + * is `'category'`), data can be simply be represented by a one-dimension + * array, like: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * **Relationship between "value" and + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.type) + * ** + * + * + When a dimension corresponds to a value axis (axis.type + * is `'value'` or `'log'`): + * + * The value can be a `number` (like `12`) (can also be a number + * in a `string` format, like `'12'`). + * + * + When a dimension corresponds to a category axis (axis.type + * is `'category'`): + * + * The value should be the ordinal of the axis.data + * (based on `0`), the string value of the axis.data. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * There is an example of double category axes: + * [Github Punchcard](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-punchCard) + * . + * + * + When a dimension corresponds to a time axis (type is `'time'`), + * the value can be: + * + * + a timestamp, like `1484141700832`, which represents a UTC time. + * + a date string, in one of the formats below: + * + a subset of + * [ISO 8601](http://www.ecma-international.org/ecma-262/5.1/#se + * c-15.9.1.15) + * , only including (all of these are treated as local time unless + * timezone is specified, which is consistent with + * [moment](https://momentjs.com/) + * ): + * + only part of year/month/date/time are specified: `'2012-03'`, + * `'2012-03-01'`, `'2012-03-01 05'`, `'2012-03-01 05:06'`. + * + separated by `"T"` or a space: `'2012-03-01T12:22:33.123'`, + * `'2012-03-01 12:22:33.123'`. + * + timezone specified: `'2012-03-01T12:22:33Z'`, `'2012-03-01T12:22:33+8000'`, + * `'2012-03-01T12:22:33-05:00'`. + * + other date string format (all of these are treated as local + * time): `'2012'`, `'2012-3-1'`, `'2012/3/1'`, `'2012/03/01'`, + * `'2009/6/12 2:00'`, `'2009/6/12 2:05:08'`, `'2009/6/12 2:05:08.123'`. + * + a JavaScript Date instance created by user: + * + Caution, when using a data string to create a Date instance, + * [browser differences and inconsistencies](http://dygraphs.com/date-formats.html) + * should be considered. + * + For example: In chrome, `new Date('2012-01-01')` is treated + * as a Jan 1st 2012 in UTC, while `new Date('2012-1-1')` and `new + * Date('2012/01/01')` are treated as Jan 1st 2012 in local timezone. + * In safari `new Date('2012-1-1')` is not supported. + * + So if you intent to perform `new Date(dateString)`, it is strongly + * recommended to use a time parse library (e.g., + * [moment](https://momentjs.com/) + * ), or use `echarts.number.parseDate`, or check + * [this](http://dygraphs.com/date-formats.html) + * . + * + * **Customize a data item:** + * + * When needing to customize a data item, it can be set as an object, + * where property `value` reprensent real value. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * **Empty value:** + * + * `'-'` or `null` or `undefined` or `NaN` can be used to describe + * that a data item is not exists (ps：_not exist_ does not means + * its value is `0`). + * + * For example, line chart can break when encounter an empty value, + * and scatter chart do not display graphic elements for empty values. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data + */ + data?: ( + (void | string | number | SeriesBar.DataObject)[] + | (void | string | number | SeriesBar.DataObject)[][] + ); + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in bar chart. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in bar chart, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.z + */ + z?: number; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesBar { + interface DataObject { + + /** + * The name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.name + */ + name?: string; + + /** + * The value of a single data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.value + */ + value?: number; + + /** + * The style setting of the text label in a single bar. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle + */ + itemStyle?: { + + /** + * Bar color.. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.barBorderWidth + */ + barBorderWidth?: number; + + /** + * The radius of rounded corner. + * Its unit is px. + * And it supports use array to respectively specify the + * 4 corner radiuses. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.barBorderRadius + */ + barBorderRadius?: any[] | number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * Bar color.. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. + * defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.barBorderWidth + */ + barBorderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.bar.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/boxplot.d.ts b/types/echarts/options/series/boxplot.d.ts new file mode 100644 index 0000000000..7eb6dee681 --- /dev/null +++ b/types/echarts/options/series/boxplot.d.ts @@ -0,0 +1,13256 @@ +declare namespace echarts { + namespace EChartOption { + /** + * [Boxplot](https://en.wikipedia.org/wiki/Box_plot) + * is a convenient way of graphically depicting groups of numerical + * data through their quartiles. + * + * **Example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot) + * + * Multiple `series` can be displayed in the same coordinate system. + * Please refer to + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=boxplot-multi&edit=1&reset=1) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot + */ + interface SeriesBoxplot { + + /** + * @default + * "boxplot" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.id + */ + id?: string; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-cartesian2d.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-cartesian2d.yAxisIndex) + * to assign the corresponding axis component. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * Whether to enable the animation when hovering on box. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.hoverAnimation + */ + hoverAnimation?: boolean; + + /** + * Layout methods, whose optional values are: + * + * + `'horizontal'`: horizontally layout all boxes. + * + * + `'vertical'`: vertically layout all boxes. + * + * The default value is decided by: + * + * + if there is a `category` axis: + * + if it is horizontal, use `'horizontal'`; + * + otherwise use `'vertical'`; + * + otherwise use `'horizontal'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.layout + */ + layout?: string; + + /** + * Up and bottom boundary of box width. + * The array is in the form of `[min, max]`. + * + * It could be absolute value in pixel, such as `[7, 50]`, or percentage, + * such as `['40%', '90%']`. + * The percentage means the percentage to the maximum possible width. + * + * + * @default + * [7, 50] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxWidth + */ + boxWidth?: any[]; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle + */ + itemStyle?: { + + /** + * boxplot color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.itemStyle) + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.color + */ + color?: string; + + /** + * boxplot border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.borderColor + */ + borderColor?: string; + + /** + * boxplot border width. No border when it is set to be 0. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle + */ + itemStyle?: { + + /** + * boxplot color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.emphasis.itemStyle) + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.color + */ + color?: string; + + /** + * boxplot border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * boxplot border width. + * No border when it is set to be 0. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.emphasis.itemStyle) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @default + * "rgba(0,0,0,0.4)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.encode + */ + encode?: object; + + /** + * Data should be the two-dimensional array shown as follow. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * Every data item (each line in the example above) in the two-dimensional + * array will be rendered into a box, and each line have five values + * as: + * + * ``` + * [min, Q1, median (or Q2), Q3, max] + * + * ``` + * + * **Data Processing** + * + * ECharts doesn't contain data processing modules, so the five + * statistic values should be calculated by yourself and then passes + * into `boxplot`. + * + * However, ECharts also provide some simple + * [raw data processing tools](https://github.com/ecomfe/echarts/tree/master/extension/dataTool) + * . For example, this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=boxplot-light-velocity&edit=1&reset=1) + * uses `echarts.dataTool.prepareBoxplotData` + * to proceed simple data statistics. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data + */ + data?: (number | SeriesBoxplot.DataObject)[][]; + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in Box plot. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in Box plot, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.silent + */ + silent?: boolean; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * + * @default + * 800 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "elasticOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.animationDelay + */ + animationDelay?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesBoxplot { + interface DataObject { + + /** + * Name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.name + */ + name?: string; + + /** + * Value of data item. + * + * ``` + * [min, Q1, median (or Q2), Q3, max] + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.value + */ + value?: any[]; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle + */ + itemStyle?: { + + /** + * boxplot color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.itemStyle) + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.color + */ + color?: string; + + /** + * boxplot border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * boxplot border width. + * No border when it is set to be 0. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * boxplot color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.emphasis.itemStyle) + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * boxplot border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * boxplot border width. + * No border when it is set to be 0. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.emphasis.itemStyle) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @default + * "rgba(0,0,0,0.4)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.boxplot.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-boxplot.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/candlestick.d.ts b/types/echarts/options/series/candlestick.d.ts new file mode 100644 index 0000000000..835e418662 --- /dev/null +++ b/types/echarts/options/series/candlestick.d.ts @@ -0,0 +1,13491 @@ +declare namespace echarts { + namespace EChartOption { + /** + * A + * [candlestick](https://en.wikipedia.org/wiki/Candlestick_chart) + * chart (also called Japanese candlestick chart) is a style of financial + * chart used to describe price movements of a security, derivative, + * or currency. + * + * ECharts3 supports both `'candlestick'` and `'k'` in + * [series.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#(series.type) + * (`'k'` would automatically turns into `'candlestick'`). + * + * **An example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick) + * + * **About color of increase and decrease** + * + * Different countries or regions have different implications on the + * color of candle stick chart. + * It may use red to imply increasing with red and decreasing with blue + * (in China mainland, Taiwan, Japan, Koera, and so on), or to imply + * increasing with green and decreasing with red (in Europ, North America, + * Hong Kong, Singapore, and so on). + * Besides color, the increase and decrease of stock may also be represented + * with candle stick with or without filling colors. + * + * We use red to represent increasing and blue decreasing by default. + * If you want to change the configuration, you may change the following + * parameters. + * + * + [series-candlestick.itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.color) + * : fill color for bullish candle stick (namely, increase) + * + [series-candlestick.itemStyle.color0](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.color0) + * : fill color for bearish candle stick (namely, decrease) + * + [series-candlestick.itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.borderColor) + * : border color for bullish candle stick (namely, increase) + * + [series-candlestick.itemStyle.borderColor0](https://ecomfe.github.io/echarts-doc/public/en/option.htmlseries-candlestick.itemStyle.borderColor0) + * : border color for bearish candle stick (namely, decrease) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick + */ + interface SeriesCandlestick { + + /** + * @default + * "candlestick" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.id + */ + id?: string; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-cartesian2d.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-cartesian2d.yAxisIndex) + * to assign the corresponding axis component. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * Whether to enable animitation when hovering on box. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.hoverAnimation + */ + hoverAnimation?: boolean; + + /** + * Layout method, whose values may be: + * + * + `'horizontal'`: horizontally layout all boxs. + * + * + `'vertical'`: vertically layout all boxs. + * + * The default value is decided by: + * + * + if there is a `category` axis: + * + if it is horizontal, use `'horizontal'`; + * + otherwise use `'vertical'`; + * + otherwise use `'horizontal'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.layout + */ + layout?: string; + + /** + * Specify bar width. + * Absolute value (like `10`) or percentage (like `'20%'`, according + * to band width) can be used. Auto adapt by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.barWidth + */ + barWidth?: number; + + /** + * Specify bar min width. + * Absolute value (like `10`) or percentage (like `'20%'`, according + * to band width) can be used. Auto adapt by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.barMinWidth + */ + barMinWidth?: number; + + /** + * Specify bar max width. + * Absolute value (like `10`) or percentage (like `'20%'`, according + * to band width) can be used. Auto adapt by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.barMaxWidth + */ + barMaxWidth?: number; + + /** + * Item style of candlestick. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle + */ + itemStyle?: { + + /** + * Fill color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.color + */ + color?: string; + + /** + * Fill color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.color0 + */ + color0?: string; + + /** + * Border color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.borderColor + */ + borderColor?: string; + + /** + * Border color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.borderColor0 + */ + borderColor0?: string; + + /** + * Border width of candlestick. + * There is no border when it is `0`. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * Emphasis style of candlestick. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle + */ + itemStyle?: { + + /** + * Fill color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.color + */ + color?: string; + + /** + * Fill color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.color0 + */ + color0?: string; + + /** + * Border color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * Border color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.borderColor0 + */ + borderColor0?: string; + + /** + * Border width of candlestick. + * There is no border when it is `0`. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * Whether to enable the optimization of large-scale data. + * It could be set when large data causes performance problem. + * + * After being enabled, `largeThreshold` can be used to indicate + * the minimum number for turning on the optimization. + * + * But when the optimization enabled, the style of single data item + * can't be customized any more. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.large + */ + large?: boolean; + + /** + * The threshold enabling the drawing optimization. + * + * + * @default + * 600 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.largeThreshold + */ + largeThreshold?: number; + + /** + * `progressive` specifies the amount of graphic elements that can + * be rendered within a frame (about 16ms) if "progressive rendering" + * enabled. + * + * When data amount is from thousand to more than 10 million, it + * will take too long time to render all of the graphic elements. + * Since ECharts 4, "progressive rendering" is supported in its + * workflow, which processes and renders data chunk by chunk alone + * with each frame, avoiding to block the UI thread of the browser. + * + * + * @default + * 5000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.progressive + */ + progressive?: number; + + /** + * If current data amount is over the threshold, "progressive rendering" + * is enabled. + * + * + * @default + * 10000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.progressiveThreshold + */ + progressiveThreshold?: number; + + /** + * Chunk approach, optional values: + * + * + `'sequential'`: slice data by data index. + * + `'mod'`: slice data by mod, which make the data items of each + * chunk coming from all over the data, bringing better visual effect + * while progressive rendering. + * + * + * @default + * "mod" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.progressiveChunkMode + */ + progressiveChunkMode?: string; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.encode + */ + encode?: object; + + /** + * Data should be the two-dimensional array shown as follow. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * Every data item (each line in the example above) represents a + * box, which contains 4 values. They are: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data + */ + data?: (number | SeriesCandlestick.DataObject)[][]; + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in candlestick. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in candlestick, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.silent + */ + silent?: boolean; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "linear" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.animationDelay + */ + animationDelay?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesCandlestick { + interface DataObject { + + /** + * Name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.name + */ + name?: string; + + /** + * Value of data item. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.value + */ + value?: any[]; + + /** + * Style of a candle box. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle + */ + itemStyle?: { + + /** + * Fill color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.color + */ + color?: string; + + /** + * Fill color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.color0 + */ + color0?: string; + + /** + * Border color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * Border color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.borderColor0 + */ + borderColor0?: string; + + /** + * Border width of candlestick. + * There is no border when it is `0`. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * Emphasis style of a candle box. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * Fill color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * Fill color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.color0 + */ + color0?: string; + + /** + * Border color of bullish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) + * + * + * @default + * "#c23531" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * Border color of bearish candle stick. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) + * + * + * @default + * #314656 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.borderColor0 + */ + borderColor0?: string; + + /** + * Border width of candlestick. + * There is no border when it is `0`. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.candlestick.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-candlestick.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/custom.d.ts b/types/echarts/options/series/custom.d.ts new file mode 100644 index 0000000000..23a73eef1d --- /dev/null +++ b/types/echarts/options/series/custom.d.ts @@ -0,0 +1,7956 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **custom series** + * + * `custom series` supports customizing graphic elements, and then generate + * more types of charts. + * + * echarts manages the creation, deletion, animation and interaction + * with other components (like + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * 、 + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * ), which frees developers from handle those issue themselves. + * + * **For example, a "x-range" chart is made by custom sereis:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom) + * + * ** + * [More samples of custom series](https://ecomfe.github.io/echarts-examples/public/index.html#chart-type-custom) + * ** + * + * ** + * [A tutotial of custom series](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Custom%20Series) + * ** + * + * **Customize the render logic (in renderItem method)** + * + * `custom series` requires developers to write a render logic by themselves. + * This render logic is called + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * . + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom) + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * will be called on each data item. + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * provides two parameters: + * + * + [params](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.params) + * : provides info about the current series and data and coordinate + * system. + * + [api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * : includes some methods. + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * method should returns graphic elements definitions.See + * [renderItem.return](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return) + * . + * + * Generally, the main process of + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * is that retrieve value from data and convert them to graphic elements + * on the current coordinate system. Two methods in + * [renderItem.arguments.api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * are always used in this procedure: + * + * + [api.value(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.value) + * is used to retrieve value from data. + * For example, `api.value(0)` + * retrieve the value of the first dimension in the current data item. + * + [api.coord(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.coord) + * is used to convert data to coordinate. + * For example, `var point = api.coord([api.value(0), + * api.value(1)])` + * converet the data to the point on the current coordinate system. + * + * Sometimes + * [api.size(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.size) + * method is needed, which calculates the size on the coordinate system + * by a given data range. + * + * Moreover, + * [api.style(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.style) + * method can be used to set style. + * It provides not only the style settings specified in + * [series.itemStyle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle) + * , but also the result of visual mapping. + * This method can also be called like `api.style({fill: + * 'green', stroke: 'yellow'})` to override those style settings. + * + * **Dimension mapping (by encode and dimension option)** + * + * In most cases, + * [series.encode](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.encode) + * is needed to be specified when using `custom series` serise, which + * indicate the mapping of dimensions, and then echarts can render appropriate + * axis by the extent of those data. + * + * `encode.tooltip` + * and `encode.label` + * can also be specified to define the content of default `tooltip` + * and `label`. + * [series.dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.dimensions) + * can also be specified to defined names of each dimensions, which + * will be displayed in tooltip. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom) + * + * **Controlled by dataZoom** + * + * When use `custom series` with + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * , + * [dataZoom.filterMode](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom.filterMode) + * usually be set as `'weakFilter'`, which prevent `dataItem` from being + * filtered when only part of its dimensions are out of the current + * data window. + * + * **Difference between `dataIndex` and `dataIndexInside`** + * + * + `dataIndex` is the index of a `dataItem` in the original data. + * + `dataIndexInside` is the index of a `dataItem` in the current data + * window (see + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * . + * + * [renderItem.arguments.api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * uses `dataIndexInside` as the input parameter but not `dataIndex`, + * because conversion from `dataIndex` to `dataIndexInside` is time-consuming. + * + * **Event listener** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom + */ + interface SeriesCustom { + + /** + * @default + * "custom" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'polar'` + * + * Use polar coordinates, with + * [polarIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.polarIndex) + * to assign the corresponding polar coordinate component. + * + * + `'geo'` + * + * Use geographic coordinate, with + * [geoIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.geoIndex) + * to assign the corresponding geographic coordinate components. + * + * + `'none'` + * + * Do not use coordinate system. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [polar coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * to combine with, which is useful for multiple polar axes in one + * chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.polarIndex + */ + polarIndex?: number; + + /** + * Index of + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * to combine with, which is useful for multiple geographic axes + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.geoIndex + */ + geoIndex?: number; + + /** + * Index of + * [calendar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#calendar) + * to combine with, which is useful for multiple calendar coordinates + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.calendarIndex + */ + calendarIndex?: number; + + /** + * `custom series` requires developers to write a render logic by + * themselves. This render logic is called + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * . + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * will be called on each data item. + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * provides two parameters: + * + * + [params](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.params) + * : provides info about the current series and data and coordinate + * system. + * + [api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * : includes some methods. + * + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * method should returns graphic elements definitions.See + * [renderItem.return](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return) + * . + * + * Generally, the main process of + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * is that retrieve value from data and convert them to graphic + * elements on the current coordinate system. Two methods in + * [renderItem.arguments.api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * are always used in this procedure: + * + * + [api.value(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.value) + * is used to retrieve value from data. + * For example, `api.value(0)` + * retrieve the value of the first dimension in the current data + * item. + * + [api.coord(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.coord) + * is used to convert data to coordinate. + * For example, `var point = api.coord([api.value(0), + * api.value(1)])` + * converet the data to the point on the current coordinate system. + * + * Sometimes + * [api.size(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.size) + * method is needed, which calculates the size on the coordinate + * system by a given data range. + * + * Moreover, + * [api.style(...)](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.style) + * method can be used to set style. + * It provides not only the style settings specified in + * [series.itemStyle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle) + * , but also the result of visual mapping. + * This method can also be called like `api.style({fill: + * 'green', stroke: 'yellow'})` to override those style settings. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem + */ + renderItem?: { + + /** + * Parameters of `renderItem`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments + */ + arguments?: { + + /** + * The first parameter of `renderItem`, including: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments) + * + * Difference between `dataIndex` and `dataIndexInside`: + * + * + `dataIndex` is the index of a `dataItem` in the original + * data. + * + `dataIndexInside` is the index of a `dataItem` in the + * current data window (see + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * . + * + * [renderItem.arguments.api](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api) + * uses `dataIndexInside` as the input parameter but not + * `dataIndex`, because conversion from `dataIndex` to `dataIndexInside` + * is time-consuming. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.params + */ + params?: object; + + /** + * The second parameter of `renderItem`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api + */ + api?: { + + /** + * Get value on the given dimension. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.value + */ + value?: Function; + + /** + * Convert data to coordinate. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.coord + */ + coord?: Function; + + /** + * Get the size by the given data range. + * + * For example, in `cartesian2d`, suppose calling `api.size([2, + * 4])` returns `[12.4, + * 55]`. + * It represents that on x axis, data range `2` corresponds + * to size `12.4`, + * and on y axis data range `4` corresponds to size + * `55`. + * + * In some coordinate systems (for example, polar) or + * when log axis is used, the size is different in different + * point. + * So the second parameter is necessary to calculate + * size on the given point. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.size + */ + size?: Function; + + /** + * The method obtains style info defined in + * [series.itemStyle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle) + * , and visual info obtained by visual mapping, and + * return them. + * Those returned info can be assigned to `style` attribute + * of graphic element definition directly. + * Developers can also override style info by calling + * this method like this: `api.style({fill: + * 'green', stroke: 'yellow'})`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.style + */ + style?: Function; + + /** + * The method obtains style info defined in + * [series.itemStyle.emphasis](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.emphasis) + * , and visual info obtained by visual mapping, and + * return them. + * Those returned info can be assigned to `style` attribute + * of graphic element definition directly. + * Developers can also override style info by calling + * this method like this: `api.style({fill: + * 'green', stroke: 'yellow'})`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.styleEmphasis + */ + styleEmphasis?: Function; + + /** + * Get the visual info. It is rarely be used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.visual + */ + visual?: Function; + + /** + * When `barLayout` is needed, (for example, when attaching + * some extra graphic elements to bar chart), this method + * can be used to obtain bar layout info. + * + * See a + * [sample](https://ecomfe.github.io/echarts-examples/public/editor.html?c=custom-bar-trend) + * . + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.barLayout + */ + barLayout?: Function; + + /** + * Obtain the current series index. + * Notice that the `currentSeriesIndex` is different + * from `seriesIndex` when legend is used to filter + * some series. + * + * ``` + * @return {number} + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.currentSeriesIndices + */ + currentSeriesIndices?: Function; + + /** + * Obtain font string, which can be used on style setting + * directly. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.arguments.api) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.font + */ + font?: Function; + + /** + * ``` + * @return {number} Width of echarts containter. + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.getWidth + */ + getWidth?: Function; + + /** + * ``` + * @return {number} Height of echarts container. + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.getHeight + */ + getHeight?: Function; + + /** + * ``` + * @return {module:zrender} zrender instance. + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.getZr + */ + getZr?: Function; + + /** + * ``` + * @return {number} The current devicePixelRatio。 + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.arguments.api.getDevicePixelRatio + */ + getDevicePixelRatio?: Function; + }; + }; + + /** + * `renderItem` should returns graphic element definitions. + * Each graphic element is an object. See + * [graphic](https://ecomfe.github.io/echarts-doc/public/en/option.html#graphic.elements) + * for detailed info. + * (But width\\height\\top\\bottom is not supported here) + * + * If nothing should be rendered in this data item, just returns + * nothing. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return + */ + return?: object; + + /** + * `group` is the only type that can contain children, so that + * a group of elements can be positioned and transformed together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group + */ + return_group?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "group" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_group) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.ignore + */ + ignore?: boolean; + + /** + * Specify width of this `group`. + * + * This width is only used for the positioning of its children. + * + * When width is `0`, children can also be positioned according + * to its parent using `left: 'center'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.width + */ + width?: number; + + /** + * Specify height of this `group`. + * + * This height is only used for the positioning of its children. + * + * When height is `0`, children can also be positioned according + * to its parent using `top: 'middle'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.height + */ + height?: number; + + /** + * In + * [custom series](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom) + * , when `diffChildrenByName` is set as `true`, for each + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * returned from + * [renderItem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem) + * , "diff" will be performed to its + * [children](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.children) + * according to the + * [name](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.name) + * attribute of each graphic elements. + * Here "diff" means that map the coming graphic elements + * to the existing graphic elements when repainting according + * to `name`, which enables the transition animation if + * data is modified. + * + * But notice that the operation is performance consuming, + * do not use it for large data amount. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.diffChildrenByName + */ + diffChildrenByName?: boolean; + + /** + * A list of children, each item is a declaration of an + * element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.children + */ + children?: any[]; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Use + * [SVG PathData](http://www.w3.org/TR/SVG/paths.html#PathData) + * to describe a path. + * Can be used to draw icons or any other shapes fitting the + * specified size by auto transforming. + * + * See examples: + * [icons](https://ecomfe.github.io/echarts-examples/public/editor.html?c=custom-calendar-icon) + * and + * [shapes](https://ecomfe.github.io/echarts-examples/public/editor.html?c=custom-gantt-flight) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path + */ + return_path?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "path" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_path) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape + */ + shape?: { + + /** + * [SVG PathData](http://www.w3.org/TR/SVG/paths.html#PathData) + * . + * + * For example, `'M0,0 L0,-20 L30,-20 C42,-20 38,-1 + * 50,-1 L70,-1 L70,0 Z'`。 + * + * If + * [width](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.width) + * , + * [height](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.height) + * , + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.x) + * and + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.y) + * specified, `pathData` will be transformed to fit + * the defined rect. + * If they are not specified, do not do that. + * + * [layout](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.layout) + * can be used to specify the transform strategy. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.pathData + */ + pathData?: string; + + /** + * Alias of + * [pathData](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.pathData) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.d + */ + d?: string; + + /** + * If + * [width](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.width) + * , + * [height](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.height) + * , + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.x) + * and + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.y) + * specified, `pathData` will be transformed to fit + * the defined rect. + * + * `layout` can be used to specify the transform strategy. + * + * Optional value: + * + * + `'center'`: Keep aspect ratio, put the path in + * the center of the rect, expand as far as possible + * but never overflow. + * + `'cover'`: Transform the path according to the + * aspect ratio of the rect, fill the rect and do not + * overflow. + * + * + * @default + * "center" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.layout + */ + layout?: string; + + /** + * The x value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.x + */ + x?: number; + + /** + * The y value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.y + */ + y?: number; + + /** + * The width of the shape of the element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.width + */ + width?: number; + + /** + * The height of the shape of the element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.shape.height + */ + height?: number; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_path.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image + */ + return_image?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "image" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_image) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style + */ + style?: { + + /** + * Specify contant of the image, can be a URL, or + * [dataURI](https://tools.ietf.org/html/rfc2397) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.image + */ + image?: string; + + /** + * The x value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.x + */ + x?: number; + + /** + * The y value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.y + */ + y?: number; + + /** + * The width of the shape of the element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.width + */ + width?: number; + + /** + * The height of the shape of the element. + * + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be + * different from the attribute names in `echarts label`, + * `echarts itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.height + */ + height?: number; + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text + */ + return_text?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "text" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_text) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style + */ + style?: { + + /** + * Text content. `\n` can be used as a line break. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.text + */ + text?: string; + + /** + * The x value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.x + */ + x?: number; + + /** + * The y value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.y + */ + y?: number; + + /** + * Font size, font type, font weight, font color, follow + * the form of + * [css font](https://developer.mozilla.org/en-US/docs/Web/CSS/font) + * . + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_text.style) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.font + */ + font?: string; + + /** + * Text horizontal alignment. + * Optional values: `'left'`, `'center'`, `'right'`. + * + * `'left'` means the left side of the text block is + * specified by the + * [style.x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.x) + * , while `'right'` means the right side of the text + * block is specified by + * [style.y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.y) + * . + * + * + * @default + * "left" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.textAlign + */ + textAlign?: string; + + /** + * Text vertical alignment. + * Optional values: `'top'`, `'middle'`, `'bottom'`. + * + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be + * different from the attribute names in `echarts label`, + * `echarts itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.textVerticalAlign + */ + textVerticalAlign?: string; + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Rectangle element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect + */ + return_rect?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "rect" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_rect) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape + */ + shape?: { + + /** + * The x value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape.x + */ + x?: number; + + /** + * The y value of the left-top corner of the element + * in the coordinate system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape.y + */ + y?: number; + + /** + * The width of the shape of the element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape.width + */ + width?: number; + + /** + * The height of the shape of the element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape.height + */ + height?: number; + + /** + * Specify border radius of the rectangular here. + * Generally, `r` should be `[topLeftRadius, topRightRadius, + * BottomRightRadius, bottomLeftRadius]`, where each + * item is a number. + * + * Abbreviation is enabled, for example: + * + * + `r`: `1` means `[1, 1, 1, 1]` + * + `r`: `[1]` means `[1, 1, 1, 1]` + * + `r`: `[1, 2]` means `[1, 2, 1, 2]` + * + `r`: `[1, 2, 3]` means `[1, 2, 3, 2]` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.shape.r + */ + r?: any[]; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Circle element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle + */ + return_circle?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_circle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.shape + */ + shape?: { + + /** + * The x value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.shape.cx + */ + cx?: number; + + /** + * The y value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.shape.cy + */ + cy?: number; + + /** + * Outside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.shape.r + */ + r?: number; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Ring element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring + */ + return_ring?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "ring" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_ring) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.shape + */ + shape?: { + + /** + * The x value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.shape.cx + */ + cx?: number; + + /** + * The y value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.shape.cy + */ + cy?: number; + + /** + * Outside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.shape.r + */ + r?: number; + + /** + * Inside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.shape.r0 + */ + r0?: number; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Sector element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector + */ + return_sector?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "sector" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_sector) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape + */ + shape?: { + + /** + * The x value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.cx + */ + cx?: number; + + /** + * The y value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.cy + */ + cy?: number; + + /** + * Outside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.r + */ + r?: number; + + /** + * Inside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.r0 + */ + r0?: number; + + /** + * start angle, in radian. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.startAngle + */ + startAngle?: number; + + /** + * end anble, in radian. + * + * + * @default + * "Math.PI * 2" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.endAngle + */ + endAngle?: number; + + /** + * Whether draw clockwise. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.shape.clockwise + */ + clockwise?: boolean; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Arc element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc + */ + return_arc?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "arc" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_arc) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape + */ + shape?: { + + /** + * The x value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.cx + */ + cx?: number; + + /** + * The y value of the center of the element in the coordinate + * system of its parent. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.cy + */ + cy?: number; + + /** + * Outside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.r + */ + r?: number; + + /** + * Inside radius. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.r0 + */ + r0?: number; + + /** + * start angle, in radian. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.startAngle + */ + startAngle?: number; + + /** + * end anble, in radian. + * + * + * @default + * "Math.PI * 2" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.endAngle + */ + endAngle?: number; + + /** + * Whether draw clockwise. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.shape.clockwise + */ + clockwise?: boolean; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Polygon element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon + */ + return_polygon?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "polygon" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_polygon) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.shape + */ + shape?: { + + /** + * A list of points, which defines the shape, like `[[22, + * 44], [44, 55], [11, 44], ...]`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.shape.points + */ + points?: any[]; + + /** + * Whether smooth the line. + * + * + If the value is number, bezier interpolation is + * used, and the value specified the level of smooth, + * which is in the range of `[0, 1]`. + * + If the value is `'spline'`, Catmull-Rom spline + * interpolation is used. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.shape.smooth + */ + smooth?: number | string; + + /** + * Whether prevent the smooth process cause the line + * out of the bounding box. + * + * Only works when `smooth` is `number` (bezier smooth). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.shape.smoothConstraint + */ + smoothConstraint?: boolean; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Polyline element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline + */ + return_polyline?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "polyline" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_polyline) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.shape + */ + shape?: { + + /** + * A list of points, which defines the shape, like `[[22, + * 44], [44, 55], [11, 44], ...]`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.shape.points + */ + points?: any[]; + + /** + * Whether smooth the line. + * + * + If the value is number, bezier interpolation is + * used, and the value specified the level of smooth, + * which is in the range of `[0, 1]`. + * + If the value is `'spline'`, Catmull-Rom spline + * interpolation is used. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.shape.smooth + */ + smooth?: number | string; + + /** + * Whether prevent the smooth process cause the line + * out of the bounding box. + * + * Only works when `smooth` is `number` (bezier smooth). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.shape.smoothConstraint + */ + smoothConstraint?: boolean; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Line element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line + */ + return_line?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "line" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_line) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape + */ + shape?: { + + /** + * x value of the start point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape.x1 + */ + x1?: number; + + /** + * y value of the start point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape.y1 + */ + y1?: number; + + /** + * x value of the end point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape.x2 + */ + x2?: number; + + /** + * y value of the end point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape.y2 + */ + y2?: number; + + /** + * Specify the percentage of drawing, useful in animation. + * + * Value range: \[0, 1\]. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.shape.percent + */ + percent?: number; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line.styleEmphasis + */ + styleEmphasis?: object; + }; + + /** + * Quadratic bezier curve or cubic bezier curve. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve + */ + return_bezierCurve?: { + + /** + * Must be specified when define a graphic element at the + * first time. + * + * Optional values: + * + * [image](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_image) + * , + * [text](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_text) + * , + * [circle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_circle) + * , + * [sector](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_sector) + * , + * [ring](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_ring) + * , + * [polygon](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon) + * , + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polyline) + * , + * [rect](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_rect) + * , + * [line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_line) + * , + * [bezierCurve](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve) + * , + * [arc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_arc) + * , + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * , + * + * + * @default + * "bezierCurve" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.type + */ + type?: string; + + /** + * id is used to specifying element when willing to update + * it. id can be ignored if you do not need it. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.id + */ + id?: string; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.position + */ + position?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.rotation + */ + rotation?: number; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [1, 1] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.scale + */ + scale?: any[]; + + /** + * `2D transform` can be applied to graphic elements, including: + * + * + [position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.position) + * : `[horizontal translate offset, vertical translate offset]`, + * `[0, 0]` by default. + * Positive value means translate towards right or bottom. + * + [rotation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.rotation) + * : Rotation in radian, `0` by default. + * Positive when anticlockwise. + * + [scale](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.scale) + * : `[horizontal scale factor, vertical scale factor]`, + * `[1, 1]` by default. + * + * [origin](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.origin) + * specifies the origin point of rotation and scaling, `[0, + * 0]` by default. + * + * Notice: + * + * + The coordinates specified in the transform attribute + * above are relative to the `[0, 0]` of the parent element + * (that is, + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * or the root canvas). Thus we are able to + * [group](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * multiple elements, and + * [groups](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_group) + * can be nested. + * + The order that the transform attributes are applied + * to a single graphic element is: Firstly, `rotation`, + * then, `scale`, finally, `position`. + * + * + * @default + * [0, 0] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.origin + */ + origin?: number; + + /** + * Define the overlap relationship between graphic elements. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.z2 + */ + z2?: number; + + /** + * See + * [diffChildrenByName](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.diffChildrenByName) + * 。 + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.name + */ + name?: string; + + /** + * User defined data, can be visited in event listeners. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.renderItem.return_bezierCurve) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.info + */ + info?: any; + + /** + * Whether response to mouse events / touch events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.silent + */ + silent?: boolean; + + /** + * Whether the element is visible. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.invisible + */ + invisible?: boolean; + + /** + * Whether the element is totally ignored (neither render + * nor listen events). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.ignore + */ + ignore?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape + */ + shape?: { + + /** + * x value of the start point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.x1 + */ + x1?: number; + + /** + * y value of the start point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.y1 + */ + y1?: number; + + /** + * x value of the end point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.x2 + */ + x2?: number; + + /** + * y value of the end point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.y2 + */ + y2?: number; + + /** + * x of control point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpx1 + */ + cpx1?: number; + + /** + * y of control point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpy1 + */ + cpy1?: number; + + /** + * x of the second control point. + * If specified, cubic bezier is used. + * + * If both `cpx2` and `cpy2` are not set, quatratic + * bezier is used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpx2 + */ + cpx2?: number; + + /** + * y of the second control point. + * If specified, cubic bezier is used. + * + * If both `cpx2` and `cpy2` are not set, quatratic + * bezier is used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.cpy2 + */ + cpy2?: number; + + /** + * Specify the percentage of drawing, useful in animation. + * + * Value range: \[0, 1\]. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.shape.percent + */ + percent?: number; + }; + + /** + * More attributes in `style` (for example, + * [rich text](https://ecomfe.github.io/echarts-doc/public/en/tutorial.html#Rich%20Text) + * ), see the `style` related attributes in + * [zrender/graphic/Displayable](https://ecomfe.github.io/zrender-doc/public/api.html#zrenderdisplayable) + * . + * + * Notice, the attribute names of the `style` of graphic + * elements is derived from `zrender`, which may be different + * from the attribute names in `echarts label`, `echarts + * itemStyle`, etc., + * although they have the same meaning. For example: + * + * + [itemStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.fill` + * + [itemStyle.borderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.stroke` + * + [label.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.color) + * => `style.textFill` + * + [label.textBorderColor](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-scatter.label.textBorderColor) + * => `style.textStroke` + * + ... + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style + */ + style?: { + + /** + * Color filled in this element. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.fill + */ + fill?: string; + + /** + * Color of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.stroke + */ + stroke?: string; + + /** + * Width of stroke. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.lineWidth + */ + lineWidth?: number; + + /** + * Width of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowBlur + */ + shadowBlur?: number; + + /** + * X offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Y offset of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * color of shadow. + * + * + * @default + * "undefined" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.style.shadowColor + */ + shadowColor?: number; + }; + + /** + * Empahsis style of the graphic element, whose structure + * is the same as + * [style](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_polygon.style) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.renderItem.return_bezierCurve.styleEmphasis + */ + styleEmphasis?: object; + }; + }; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.encode + */ + encode?: object; + + /** + * When + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, `seriesLayoutBy` specifies whether the column or the + * row of `dataset` is mapped to the series, namely, the series + * is "layout" on columns or rows. Optional values: + * + * + 'column': by default, the columns of `dataset` are mapped the + * series. In this case, each column represents a dimension. + * + 'row'：the rows of `dataset` are mapped to the series. + * In this case, each row represents a dimension. + * + * Check this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=dataset-series-layout-by) + * . + * + * + * @default + * "column" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.seriesLayoutBy + */ + seriesLayoutBy?: string; + + /** + * If + * [series.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * is not specified, and + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * exists, the series will use `dataset`. + * `datasetIndex` specifies which dataset will be used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.datasetIndex + */ + datasetIndex?: number; + + /** + * Data array of series, which can be in the following forms: + * + * Notice, if no `data` specified in series, and there is + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * in option, series will use the first + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * as its datasource. If `data` has been specified, + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * will not used. + * + * `series.datasetIndex` can be used to specify other + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * . + * + * Basically, data is represented by a two-dimension array, like + * the example below, where each colum is named as a "dimension". + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * + In + * [cartesian (grid)](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , "dimX" and "dimY" correspond to + * [xAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * and + * [yAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * repectively. + * + In + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * "dimX" and "dimY" correspond to + * [radiusAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis) + * 和 + * [angleAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#anbleAxis) + * repectively. + * + Other dimensions are optional, which can be used in other place. + * For example: + * + [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * can map one or more dimensions to viusal (color, symbol size + * ...). + * + [series.symbolSize](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.symbolSize) + * can be set as a callback function, where symbol size can be calculated + * by values of a certain dimension. + * + Values in other dimensions can be shown by + * [tooltip.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.formatter) + * or + * [series.label.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.label.formatter) + * . + * + * Especially, when there is one and only one category axis (axis.type + * is `'category'`), data can be simply be represented by a one-dimension + * array, like: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * **Relationship between "value" and + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.type) + * ** + * + * + When a dimension corresponds to a value axis (axis.type + * is `'value'` or `'log'`): + * + * The value can be a `number` (like `12`) (can also be a number + * in a `string` format, like `'12'`). + * + * + When a dimension corresponds to a category axis (axis.type + * is `'category'`): + * + * The value should be the ordinal of the axis.data + * (based on `0`), the string value of the axis.data. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * There is an example of double category axes: + * [Github Punchcard](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-punchCard) + * . + * + * + When a dimension corresponds to a time axis (type is `'time'`), + * the value can be: + * + * + a timestamp, like `1484141700832`, which represents a UTC time. + * + a date string, in one of the formats below: + * + a subset of + * [ISO 8601](http://www.ecma-international.org/ecma-262/5.1/#se + * c-15.9.1.15) + * , only including (all of these are treated as local time unless + * timezone is specified, which is consistent with + * [moment](https://momentjs.com/) + * ): + * + only part of year/month/date/time are specified: `'2012-03'`, + * `'2012-03-01'`, `'2012-03-01 05'`, `'2012-03-01 05:06'`. + * + separated by `"T"` or a space: `'2012-03-01T12:22:33.123'`, + * `'2012-03-01 12:22:33.123'`. + * + timezone specified: `'2012-03-01T12:22:33Z'`, `'2012-03-01T12:22:33+8000'`, + * `'2012-03-01T12:22:33-05:00'`. + * + other date string format (all of these are treated as local + * time): `'2012'`, `'2012-3-1'`, `'2012/3/1'`, `'2012/03/01'`, + * `'2009/6/12 2:00'`, `'2009/6/12 2:05:08'`, `'2009/6/12 2:05:08.123'`. + * + a JavaScript Date instance created by user: + * + Caution, when using a data string to create a Date instance, + * [browser differences and inconsistencies](http://dygraphs.com/date-formats.html) + * should be considered. + * + For example: In chrome, `new Date('2012-01-01')` is treated + * as a Jan 1st 2012 in UTC, while `new Date('2012-1-1')` and `new + * Date('2012/01/01')` are treated as Jan 1st 2012 in local timezone. + * In safari `new Date('2012-1-1')` is not supported. + * + So if you intent to perform `new Date(dateString)`, it is strongly + * recommended to use a time parse library (e.g., + * [moment](https://momentjs.com/) + * ), or use `echarts.number.parseDate`, or check + * [this](http://dygraphs.com/date-formats.html) + * . + * + * **Customize a data item:** + * + * When needing to customize a data item, it can be set as an object, + * where property `value` reprensent real value. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * **Empty value:** + * + * `'-'` or `null` or `undefined` or `NaN` can be used to describe + * that a data item is not exists (ps：_not exist_ does not means + * its value is `0`). + * + * For example, line chart can break when encounter an empty value, + * and scatter chart do not display graphic elements for empty values. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data + */ + data?: ( + (void | string | number | SeriesCustom.DataObject)[] + | (void | string | number | SeriesCustom.DataObject)[][] + ); + + /** + * `zlevel` value of all graghical elements in custom series. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in custom series, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.silent + */ + silent?: boolean; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesCustom { + interface DataObject { + + /** + * Name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.name + */ + name?: string; + + /** + * Value of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.value + */ + value?: number | number[]; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.custom.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-custom.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/effect-scatter.d.ts b/types/echarts/options/series/effect-scatter.d.ts new file mode 100644 index 0000000000..885e5d385b --- /dev/null +++ b/types/echarts/options/series/effect-scatter.d.ts @@ -0,0 +1,16799 @@ +declare namespace echarts { + namespace EChartOption { + /** + * The scatter (bubble) graph with ripple animation. + * The special animation effect can visually highlights some data. + * + * **Tip:** The effects of map was achieved through markPoint in ECharts + * 2.x. + * However, in ECharts 3, effectScatter on geographic coordinate is + * recommended for achieving that effects of map. + * + * **Here is the example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter + */ + interface SeriesEffectScatter { + + /** + * @default + * "effectScatter" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * Type of effect. + * Only ripple effect of `'ripple'` is supported currently. + * + * + * @default + * "ripple" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectType + */ + effectType?: string; + + /** + * When to show the effect. + * + * **Options:** + * + * + `'render'` Show the effect when rendering is done. + * + `'emphasis'` Show the effect when it is highlight (hover). + * + * + * @default + * "render" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.showEffectOn + */ + showEffectOn?: string; + + /** + * Related configurations about ripple effect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.rippleEffect + */ + rippleEffect?: { + + /** + * The period duration of animation, in seconds. + * + * + * @default + * 4 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.rippleEffect.period + */ + period?: number; + + /** + * The maximum zooming scale of ripples in animation. + * + * + * @default + * 2.5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.rippleEffect.scale + */ + scale?: number; + + /** + * The brush type for ripples. + * options: `'stroke'` and `'fill'`. + * + * + * @default + * "fill" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.rippleEffect.brushType + */ + brushType?: string; + }; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'polar'` + * + * Use polar coordinates, with + * [polarIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.polarIndex) + * to assign the corresponding polar coordinate component. + * + * + `'geo'` + * + * Use geographic coordinate, with + * [geoIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.geoIndex) + * to assign the corresponding geographic coordinate components. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [polar coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * to combine with, which is useful for multiple polar axes in one + * chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.polarIndex + */ + polarIndex?: number; + + /** + * Index of + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * to combine with, which is useful for multiple geographic axes + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.geoIndex + */ + geoIndex?: number; + + /** + * Index of + * [calendar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#calendar) + * to combine with, which is useful for multiple calendar coordinates + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.calendarIndex + */ + calendarIndex?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @default + * 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.symbolOffset + */ + symbolOffset?: any[]; + + /** + * The mouse style when mouse hovers on an element, the same as + * `cursor` property in `CSS`. + * + * + * @default + * "pointer" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.cursor + */ + cursor?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally and + * move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.color + */ + color?: string | Function; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.color + */ + color?: string | Function; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * When + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, `seriesLayoutBy` specifies whether the column or the + * row of `dataset` is mapped to the series, namely, the series + * is "layout" on columns or rows. Optional values: + * + * + 'column': by default, the columns of `dataset` are mapped the + * series. In this case, each column represents a dimension. + * + 'row'：the rows of `dataset` are mapped to the series. + * In this case, each row represents a dimension. + * + * Check this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=dataset-series-layout-by) + * . + * + * + * @default + * "column" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.seriesLayoutBy + */ + seriesLayoutBy?: string; + + /** + * If + * [series.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * is not specified, and + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * exists, the series will use `dataset`. + * `datasetIndex` specifies which dataset will be used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.datasetIndex + */ + datasetIndex?: number; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.encode + */ + encode?: object; + + /** + * Data array of series, which can be in the following forms: + * + * Notice, if no `data` specified in series, and there is + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * in option, series will use the first + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * as its datasource. If `data` has been specified, + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * will not used. + * + * `series.datasetIndex` can be used to specify other + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * . + * + * Basically, data is represented by a two-dimension array, like + * the example below, where each colum is named as a "dimension". + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * + In + * [cartesian (grid)](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , "dimX" and "dimY" correspond to + * [xAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * and + * [yAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * repectively. + * + In + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * "dimX" and "dimY" correspond to + * [radiusAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis) + * 和 + * [angleAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#anbleAxis) + * repectively. + * + Other dimensions are optional, which can be used in other place. + * For example: + * + [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * can map one or more dimensions to viusal (color, symbol size + * ...). + * + [series.symbolSize](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.symbolSize) + * can be set as a callback function, where symbol size can be calculated + * by values of a certain dimension. + * + Values in other dimensions can be shown by + * [tooltip.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.formatter) + * or + * [series.label.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.label.formatter) + * . + * + * Especially, when there is one and only one category axis (axis.type + * is `'category'`), data can be simply be represented by a one-dimension + * array, like: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * **Relationship between "value" and + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.type) + * ** + * + * + When a dimension corresponds to a value axis (axis.type + * is `'value'` or `'log'`): + * + * The value can be a `number` (like `12`) (can also be a number + * in a `string` format, like `'12'`). + * + * + When a dimension corresponds to a category axis (axis.type + * is `'category'`): + * + * The value should be the ordinal of the axis.data + * (based on `0`), the string value of the axis.data. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * There is an example of double category axes: + * [Github Punchcard](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-punchCard) + * . + * + * + When a dimension corresponds to a time axis (type is `'time'`), + * the value can be: + * + * + a timestamp, like `1484141700832`, which represents a UTC time. + * + a date string, in one of the formats below: + * + a subset of + * [ISO 8601](http://www.ecma-international.org/ecma-262/5.1/#se + * c-15.9.1.15) + * , only including (all of these are treated as local time unless + * timezone is specified, which is consistent with + * [moment](https://momentjs.com/) + * ): + * + only part of year/month/date/time are specified: `'2012-03'`, + * `'2012-03-01'`, `'2012-03-01 05'`, `'2012-03-01 05:06'`. + * + separated by `"T"` or a space: `'2012-03-01T12:22:33.123'`, + * `'2012-03-01 12:22:33.123'`. + * + timezone specified: `'2012-03-01T12:22:33Z'`, `'2012-03-01T12:22:33+8000'`, + * `'2012-03-01T12:22:33-05:00'`. + * + other date string format (all of these are treated as local + * time): `'2012'`, `'2012-3-1'`, `'2012/3/1'`, `'2012/03/01'`, + * `'2009/6/12 2:00'`, `'2009/6/12 2:05:08'`, `'2009/6/12 2:05:08.123'`. + * + a JavaScript Date instance created by user: + * + Caution, when using a data string to create a Date instance, + * [browser differences and inconsistencies](http://dygraphs.com/date-formats.html) + * should be considered. + * + For example: In chrome, `new Date('2012-01-01')` is treated + * as a Jan 1st 2012 in UTC, while `new Date('2012-1-1')` and `new + * Date('2012/01/01')` are treated as Jan 1st 2012 in local timezone. + * In safari `new Date('2012-1-1')` is not supported. + * + So if you intent to perform `new Date(dateString)`, it is strongly + * recommended to use a time parse library (e.g., + * [moment](https://momentjs.com/) + * ), or use `echarts.number.parseDate`, or check + * [this](http://dygraphs.com/date-formats.html) + * . + * + * **Customize a data item:** + * + * When needing to customize a data item, it can be set as an object, + * where property `value` reprensent real value. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * **Empty value:** + * + * `'-'` or `null` or `undefined` or `NaN` can be used to describe + * that a data item is not exists (ps：_not exist_ does not means + * its value is `0`). + * + * For example, line chart can break when encounter an empty value, + * and scatter chart do not display graphic elements for empty values. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data + */ + data?: ( + (void | number | string | SeriesEffectScatter.DataObject)[] + | (void | number | string | SeriesEffectScatter.DataObject)[][] + ); + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.zlevel + */ + zlevel?: number; + + /** + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.z + */ + z?: number; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesEffectScatter { + interface DataObject { + + /** + * Symbol of single data. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data) + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.symbol + */ + symbol?: string; + + /** + * single data 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`. + * + * + * @default + * 4 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of single data symbol. + * Note that when `symbol` is set to be `'arrow'` in `markLine`, + * `symbolRotate` value will be ignored, and compulsively use + * tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of single data 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.effectScatter.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-effectScatter.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/funnel.d.ts b/types/echarts/options/series/funnel.d.ts new file mode 100644 index 0000000000..185c484c0d --- /dev/null +++ b/types/echarts/options/series/funnel.d.ts @@ -0,0 +1,16496 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **Funnel chart** + * + * **sample:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel + */ + interface SeriesFunnel { + + /** + * @default + * "funnel" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.name + */ + name?: string; + + /** + * The specified minimum value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.min + */ + min?: number; + + /** + * The specified maximum value. + * + * + * @default + * 100 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.max + */ + max?: number; + + /** + * The mapped width from minimum data value + * [min](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.min) + * . + * + * It can be absolute pixel and also the percentage of + * [layout width](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.width) + * + * If you don't want the graph of minimum value to be a triangle, + * you can set up this property larger than 0. + * + * + * @default + * '0%' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.minSize + */ + minSize?: string; + + /** + * The mapped width from maximum data value + * [max](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.max) + * . + * + * It can be absolute pixel and also the percentage of + * [layout width](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.width) + * . + * + * + * @default + * '100%' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.maxSize + */ + maxSize?: string; + + /** + * Data sorting, which can be whether `'ascending'`, `'descending'`, + * `'none'`(in data order) or a function, which is the same as `Array.prototype.sort(function + * (a, b) { ... })`; + * + * + * @default + * "descending" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.sort + */ + sort?: string; + + /** + * Gap between each trapezoid. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.gap + */ + gap?: number; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * Horizontal align. + * Defaults to align center. Can be 'left', 'right', 'center'. + * + * + * @default + * "center" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnelAlign + */ + funnelAlign?: string; + + /** + * Text label of funnel chart, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label + */ + label?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.show + */ + show?: boolean; + + /** + * Label position. + * + * **Options:** + * + * + `'left'` + * + * Left side of funnel chart. + * The corresponding trapezoid would be related to through + * [visual guide line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine) + * . + * + * + `'right'` + * + * Right side of funnel chart. + * The corresponding trapezoid would be related to through + * [visual guide line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine) + * . + * + * + `'inside'` + * + * Inside the trapezoid of funnel chart. + * + * + `'inner'` equals to `'inside'`. + * + * + `'center'` equals to `'inside'`. + * + * + * @default + * "outside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * The visual guide line style of label. When + * [label position](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.label.position) + * is set as `'left'`or`'right'`, the visual guide line will show. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine + */ + labelLine?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.show + */ + show?: boolean; + + /** + * The length of the first part from visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.length + */ + length?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.labelLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.labelLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of visual guide line in emphasis status. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis + */ + emphasis?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.show + */ + show?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.labelLine.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.labelLine.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + }; + }; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.color + */ + color?: string | Function; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label + */ + label?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine + */ + labelLine?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.show + */ + show?: boolean; + + /** + * The length of the first part from visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.length + */ + length?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.labelLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.labelLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of visual guide line in emphasis status. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis + */ + emphasis?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.show + */ + show?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.labelLine.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.emphasis.labelLine.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.emphasis.labelLine.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + }; + }; + }; + + /** + * When + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, `seriesLayoutBy` specifies whether the column or the + * row of `dataset` is mapped to the series, namely, the series + * is "layout" on columns or rows. Optional values: + * + * + 'column': by default, the columns of `dataset` are mapped the + * series. In this case, each column represents a dimension. + * + 'row'：the rows of `dataset` are mapped to the series. + * In this case, each row represents a dimension. + * + * Check this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=dataset-series-layout-by) + * . + * + * + * @default + * "column" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.seriesLayoutBy + */ + seriesLayoutBy?: string; + + /** + * If + * [series.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * is not specified, and + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * exists, the series will use `dataset`. + * `datasetIndex` specifies which dataset will be used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.datasetIndex + */ + datasetIndex?: number; + + /** + * Data array of series, which can be a single data value, like: + * + * ``` + * [12, 34, 56, 10, 23] + * + * ``` + * + * Or, if need extra dimensions for components like + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * to map to graphic attributes like color, it can also be in the + * form of array. For example: + * + * ``` + * [[12, 14], [34, 50], [56, 30], [10, 15], [23, 10]] + * + * ``` + * + * In this case, we can assgin the second value in each arrary item + * to + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * component. + * + * More likely, we need to assign name to each data item, in which + * case each item should be an object: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * Each data item can be further custerized: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data + */ + data?: ( + number[] + | number[][] + | SeriesFunnel.DataObject[] + ); + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.name + */ + name?: string; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0 + */ + 0?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1 + */ + 1?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0 + */ + 0?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1 + */ + 1?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesFunnel { + interface DataObject { + + /** + * the name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.name + */ + name?: string; + + /** + * data value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.value + */ + value?: number; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * The label configuration of a single data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label + */ + label?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.show + */ + show?: boolean; + + /** + * Label position. + * + * **Options:** + * + * + `'left'` + * + * Left side of funnel chart. + * The corresponding trapezoid would be related to through + * [visual guide line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine) + * . + * + * + `'right'` + * + * Right side of funnel chart. + * The corresponding trapezoid would be related to through + * [visual guide line](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.labelLine) + * . + * + * + `'inside'` + * + * Inside the trapezoid of funnel chart. + * + * + `'inner'` equals to `'inside'`. + * + * + `'center'` equals to `'inside'`. + * + * + * @default + * "outside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.position + */ + position?: string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine + */ + labelLine?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.show + */ + show?: boolean; + + /** + * The length of the first part from visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.length + */ + length?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.labelLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.labelLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of visual guide line in emphasis status. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis + */ + emphasis?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.show + */ + show?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.labelLine.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.labelLine.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.labelLine.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label + */ + label?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.show + */ + show?: boolean; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when + * using background image, or auto adapted by + * default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine + */ + labelLine?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.show + */ + show?: boolean; + + /** + * The length of the first part from visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.length + */ + length?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.labelLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.labelLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of visual guide line in emphasis status. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis + */ + emphasis?: { + + /** + * Whether to show visual guide line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.show + */ + show?: boolean; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.labelLine.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.emphasis.labelLine.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.emphasis.labelLine.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + }; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.funnel.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-funnel.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/gauge.d.ts b/types/echarts/options/series/gauge.d.ts new file mode 100644 index 0000000000..61093e5e5e --- /dev/null +++ b/types/echarts/options/series/gauge.d.ts @@ -0,0 +1,14272 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **Gauge chart** + * + * **Example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge + */ + interface SeriesGauge { + + /** + * @default + * "gauge" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.name + */ + name?: string; + + /** + * The radius of gauge chart. + * It can be a percentage value of the smaller of container half + * width and half height, also can be an absolute value. + * + * {{ use partial-legend-hover-link }} + * + * + * @default + * '75%' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.radius + */ + radius?: number | string; + + /** + * The start angle of gauge chart. The direct right side of + * [circle center](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.center) + * is `0` degree, the right above it is `90` degree, the direct + * left side of it is `180` degree. + * + * + * @default + * 225 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.startAngle + */ + startAngle?: number; + + /** + * The end angle of gauge chart. + * + * + * @default + * -45 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.endAngle + */ + endAngle?: number; + + /** + * Whether the scale in gauge chart increases clockwise. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.clockwise + */ + clockwise?: boolean; + + /** + * The minimum data value which map to + * [minAngle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.minAngle) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.min + */ + min?: number; + + /** + * The maximum data value which map to + * [maxAngle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.maxAngle) + * . + * + * + * @default + * 100 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.max + */ + max?: number; + + /** + * The number of split segments of gauge chart scale. + * + * + * @default + * 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitNumber + */ + splitNumber?: number; + + /** + * The related configuration about the axis line of gauge chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine + */ + axisLine?: { + + /** + * Whether to show the axis line of gauge chart. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.show + */ + show?: boolean; + + /** + * The style of the axis line of gauge chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle + */ + lineStyle?: { + + /** + * The axis line of gauge chart can be divided to several + * segments in different colors. + * The end position and color of each segment can be expressed + * by an array. + * + * Default value: + * + * ``` + * [[0.2, '#91c7ae'], [0.8, '#63869e'], [1, '#c23531']] + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.color + */ + color?: any[]; + + /** + * The width of axis line. + * + * + * @default + * 30 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.width + */ + width?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * The style of split line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine + */ + splitLine?: { + + /** + * Whether to show the split line. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.show + */ + show?: boolean; + + /** + * The length of split line, can be a pecentage value relative + * to radius. + * + * + * @default + * 30 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.length + */ + length?: number | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.splitLine.lineStyle) + * + * + * @default + * "#eee" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.splitLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.splitLine.lineStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * The tick line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick + */ + axisTick?: { + + /** + * Whether to show the scale. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.show + */ + show?: boolean; + + /** + * The split scale number between split line. + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.splitNumber + */ + splitNumber?: number; + + /** + * The length of tick line, can be a pecentage value relative + * to radius. + * + * + * @default + * 8 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.length + */ + length?: number | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisTick.lineStyle) + * + * + * @default + * "#eee" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisTick.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisTick.lineStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * Axis tick label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel + */ + axisLabel?: { + + /** + * Whether to show the label. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.show + */ + show?: boolean; + + /** + * The content formatter of scale label, which supports both + * string template and callback function. Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Gauge chart pointer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.pointer + */ + pointer?: { + + /** + * Whether to show the pointer. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.pointer.show + */ + show?: boolean; + + /** + * The length of pointer which could be absolute value and also + * the percentage relative to + * [radius](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.radius) + * . + * + * + * @default + * '80%' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.pointer.length + */ + length?: number | string; + + /** + * The width of pointer. + * + * + * @default + * 8 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.pointer.width + */ + width?: number; + }; + + /** + * The style of gauge chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle + */ + itemStyle?: { + + /** + * The color of pointer. Defaults to use + * [the color of section](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.color) + * where the numerical value belongs to. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * The title of gauge chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title + */ + title?: { + + /** + * Whether to show the title. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.show + */ + show?: boolean; + + /** + * The offset position relative to the center of gauge chart. + * The first item of array is the horizontal offset; the second + * item of array is the vertical offset. + * It could be absolute value and also the percentage relative + * to the radius of gauge chart. + * + * + * @default + * [0, '-40%'] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.offsetCenter + */ + offsetCenter?: any[]; + + /** + * text color. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 15 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.title.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.title.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * The detail about gauge chart which is used to show data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail + */ + detail?: { + + /** + * Whether to show the details. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.height + */ + height?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.borderWidth + */ + borderWidth?: number; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.borderColor + */ + borderColor?: string; + + /** + * The offset position relative to the center of gauge chart. + * The first item of array is the horizontal offset; the second + * item of array is the vertical offset. + * It could be absolute value and also the percentage relative + * to the radius of gauge chart. + * + * + * @default + * [0, '40%'] + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.offsetCenter + */ + offsetCenter?: any[]; + + /** + * text color. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 15 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.lineHeight + */ + lineHeight?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich + */ + rich?: { + /** + * The text color. Defaults to use + * [the color of section](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.axisLine.lineStyle.color) + * where the numerical value belongs to. + * + * + * @todo check that the option is valid and should be here + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.color + */ + // color?: string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.detail.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.detail.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.name + */ + name?: string; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0 + */ + 0?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1 + */ + 1?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0 + */ + 0?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1 + */ + 1?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.gauge.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-gauge.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } +} diff --git a/types/echarts/options/series/graph.d.ts b/types/echarts/options/series/graph.d.ts new file mode 100644 index 0000000000..784a6f6d6b --- /dev/null +++ b/types/echarts/options/series/graph.d.ts @@ -0,0 +1,22096 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **relation graph** + * + * Graph is a diagram to represent + * [nodes](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.nodes) + * and the + * [links](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.layout) + * configuration as `'force'`. + * + * **Example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph + */ + interface SeriesGraph { + + /** + * @default + * "graph" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.name + */ + name?: string; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'polar'` + * + * Use polar coordinates, with + * [polarIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.polarIndex) + * to assign the corresponding polar coordinate component. + * + * + `'geo'` + * + * Use geographic coordinate, with + * [geoIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.geoIndex) + * to assign the corresponding geographic coordinate components. + * + * + `'none'` + * + * Do not use coordinate system. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [polar coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * to combine with, which is useful for multiple polar axes in one + * chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.polarIndex + */ + polarIndex?: number; + + /** + * Index of + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * to combine with, which is useful for multiple geographic axes + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.geoIndex + */ + geoIndex?: number; + + /** + * Index of + * [calendar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#calendar) + * to combine with, which is useful for multiple calendar coordinates + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.calendarIndex + */ + calendarIndex?: number; + + /** + * Whether to enable the highlight animation effect of mousr hover + * node. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.hoverAnimation + */ + hoverAnimation?: boolean; + + /** + * Graph layout. + * + * **Options:** + * + * + `'none'` No any layout, use + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.y) + * provided in + * [node](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data) + * as the position of node. + * + * + `'circular'` Adopt circular layout, see the example + * [Les Miserables](https://ecomfe.github.io/echarts-examples/public/editor.html?c=graph-circular-layout) + * . + * + * + `'force'` Adopt force-directed layout, see the example + * [Force](https://ecomfe.github.io/echarts-examples/public/editor.html?c=graph-force) + * , the detail about configrations of layout are in + * [graph.force](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force) + * + * + * @default + * "none" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.layout + */ + layout?: string; + + /** + * Configuration about circular layout. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.circular + */ + circular?: { + + /** + * Whether to rotate the label automatically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.circular.rotateLabel + */ + rotateLabel?: boolean; + }; + + /** + * 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://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.y) + * provided in + * [node](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force.initLayout + */ + initLayout?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force.repulsion + */ + repulsion?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force.gravity + */ + gravity?: number; + + /** + * The distance between 2 nodes on edge. + * This distance is also affected by + * [repulsion](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force.edgeLength + */ + edgeLength?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.force.layoutAnimation + */ + layoutAnimation?: boolean; + }; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.roam + */ + roam?: boolean | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.nodeScaleRatio + */ + nodeScaleRatio?: number; + + /** + * If node is draggable. + * Only available when using force-directed layout. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.draggable + */ + draggable?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters of + * data item. + * + * + * @default + * 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to focus/highlight the hover node and it's adjacencies. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.focusNodeAdjacency + */ + focusNodeAdjacency?: boolean; + + /** + * Symbol of two ends of edge line. + * + * For example: + * + * ``` + * edgeSymbol: ['circle', 'arrow'] + * + * ``` + * + * + * @default + * "[none', 'none']" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeSymbol + */ + edgeSymbol?: any[] | string; + + /** + * Size of symbol of two ends of edge line. + * Can be an array or a single number. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @default + * 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeSymbolSize + */ + edgeSymbolSize?: any[] | number; + + /** + * The mouse style when mouse hovers on an element, the same as + * `cursor` property in `CSS`. + * + * + * @default + * "pointer" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.cursor + */ + cursor?: string; + + /** + * Graphic style of , `emphasis` is the style when it is highlighted, + * like being hovered by mouse, or highlighted via legend connect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.color + */ + color?: string | Function; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of edge line. + * [lineStyle.color](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.lineStyle) + * + * + * @default + * "#aaa" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.lineStyle.curveness + */ + curveness?: number; + }; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally and + * move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel + */ + edgeLabel?: { + + /** + * If show label on edge. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.show + */ + show?: boolean; + + /** + * Label position, options： + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "middle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel + */ + edgeLabel?: { + + /** + * If show label on edge. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.show + */ + show?: boolean; + + /** + * Label position, options： + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "middle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.emphasis.edgeLabel.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * The categories of node, which is optional. + * If there is a classification of nodes, the category of each node + * can be assigned through + * [data\[i\].category](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.category) + * + * And the style of category will also be applied to the style of + * nodes. `categories` can also be used in + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories + */ + categories?: { + + /** + * Name of category, which is used to correspond with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * and the content of + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.name + */ + name?: string; + + /** + * Symbol of node of this category. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.symbol + */ + symbol?: string; + + /** + * node of this category 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of node of this category symbol. + * Note that when `symbol` is set to be `'arrow'` in `markLine`, + * `symbolRotate` value will be ignored, and compulsively use + * tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of node of this category 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.symbolOffset + */ + symbolOffset?: any[]; + + /** + * The style of node in this category. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * The label style of node in this category. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.categories.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.categories.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Nodes list of graph. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data + */ + data?: SeriesGraph.DataObject[]; + + /** + * Alias of + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.nodes + */ + nodes?: any[]; + + /** + * Relational data between nodes. Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links + */ + links?: { + + /** + * [name of source node](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.name) + * on edge + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.source + */ + source?: string; + + /** + * [name of target node](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.name) + * on edge + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.target + */ + target?: string; + + /** + * value of edge, can be mapped to edge length in force graph. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.value + */ + value?: number; + + /** + * Line style of edges. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.opacity + */ + opacity?: number; + + /** + * The curveness of edge, supporting values from 0 to 1. + * The curveness will be larger as the value becomes lager. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.lineStyle.curveness + */ + curveness?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label + */ + label?: { + + /** + * If show label on edge. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.show + */ + show?: boolean; + + /** + * Label position, options： + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "middle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label + */ + label?: { + + /** + * If show label on edge. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.show + */ + show?: boolean; + + /** + * Label position, options： + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "middle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when + * using background image, or auto adapted by + * default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.links.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * Symbol of edge ends. + * Can be an array with two item to specify two ends, or a string + * specifies both ends. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size of edge ends. + * Can be an array with two item to specify two ends, or a string + * specifies both ends. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links.symbolSize + */ + symbolSize?: any[] | string; + }; + + /** + * Alias of + * [links](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.links) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.edges + */ + edges?: any[]; + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.zlevel + */ + zlevel?: number; + + /** + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.z + */ + z?: number; + + /** + * Distance between 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 + * "center" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.left + */ + left?: number | string; + + /** + * Distance between 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 + * "middle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.top + */ + top?: number | string; + + /** + * Distance between 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%'`. + * + * Adaptive by default. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.right + */ + right?: number | string; + + /** + * Distance between 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%'`. + * + * Adaptive by default. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.bottom + */ + bottom?: number | string; + + /** + * Width of component. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.width + */ + width?: number | string; + + /** + * Height of component. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.height + */ + height?: number | string; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.silent + */ + silent?: boolean; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesGraph { + interface DataObject { + + /** + * Name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.name + */ + name?: string; + + /** + * `x` value of node position. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.x + */ + x?: number; + + /** + * `y` value of node position. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.y + */ + y?: number; + + /** + * If node are fixed when doing force directed layout. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.fixed + */ + fixed?: boolean; + + /** + * Value of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.value + */ + value?: any[] | number; + + /** + * Index of category which the data item belongs to. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.category + */ + category?: number; + + /** + * Symbol of node of this category. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.symbol + */ + symbol?: string; + + /** + * node of this category 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of node of this category symbol. + * Note that when `symbol` is set to be `'arrow'` in `markLine`, + * `symbolRotate` value will be ignored, and compulsively use + * tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of node of this category 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * The style of this node. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle + */ + itemStyle?: { + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * The label style of this node. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.graph.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-graph.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/heatmap.d.ts b/types/echarts/options/series/heatmap.d.ts new file mode 100644 index 0000000000..af38c31e17 --- /dev/null +++ b/types/echarts/options/series/heatmap.d.ts @@ -0,0 +1,15355 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **heat map** + * + * Heat map mainly use colors to represent values, which must be used + * along with + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * component. + * + * It can be used in either + * [rectangular coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * or + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * + * But the behaviour on them are quite different. + * Rectangular coordinate must have two catagories to use it. + * + * Here are the examples using it in rectangular coordinate and geographic + * coordinate: + * + * **rectangular coordinate:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap) + * + * **geographic coordinate:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap + */ + interface SeriesHeatmap { + + /** + * @default + * "heatmap" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.name + */ + name?: string; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'geo'` + * + * Use geographic coordinate, with + * [geoIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.geoIndex) + * to assign the corresponding geographic coordinate components. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * to combine with, which is useful for multiple geographic axes + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.geoIndex + */ + geoIndex?: number; + + /** + * Index of + * [calendar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#calendar) + * to combine with, which is useful for multiple calendar coordinates + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.calendarIndex + */ + calendarIndex?: number; + + /** + * Blur size of each data point. It is valid with + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * of 'geo' value. + * + * + * @default + * 20 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.blurSize + */ + blurSize?: number; + + /** + * Minimum opacity. It is valid with + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * of 'geo' value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.minOpacity + */ + minOpacity?: number; + + /** + * Maximum opacity. It is valid with + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * of 'geo' value. + * + * + * @default + * 1 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.maxOpacity + */ + maxOpacity?: number; + + /** + * Work for + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * : 'cartesian2d'. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally and + * move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Work for + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * : 'cartesian2d'. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Data array of series, which can be in the following forms: + * + * Notice, if no `data` specified in series, and there is + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * in option, series will use the first + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * as its datasource. If `data` has been specified, + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * will not used. + * + * `series.datasetIndex` can be used to specify other + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * . + * + * Basically, data is represented by a two-dimension array, like + * the example below, where each colum is named as a "dimension". + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap) + * + * + In + * [cartesian (grid)](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , "dimX" and "dimY" correspond to + * [xAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * and + * [yAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * repectively. + * + In + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * "dimX" and "dimY" correspond to + * [radiusAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis) + * 和 + * [angleAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#anbleAxis) + * repectively. + * + Other dimensions are optional, which can be used in other place. + * For example: + * + [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * can map one or more dimensions to viusal (color, symbol size + * ...). + * + [series.symbolSize](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.symbolSize) + * can be set as a callback function, where symbol size can be calculated + * by values of a certain dimension. + * + Values in other dimensions can be shown by + * [tooltip.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.formatter) + * or + * [series.label.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.label.formatter) + * . + * + * Especially, when there is one and only one category axis (axis.type + * is `'category'`), data can be simply be represented by a one-dimension + * array, like: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap) + * + * **Relationship between "value" and + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.type) + * ** + * + * + When a dimension corresponds to a value axis (axis.type + * is `'value'` or `'log'`): + * + * The value can be a `number` (like `12`) (can also be a number + * in a `string` format, like `'12'`). + * + * + When a dimension corresponds to a category axis (axis.type + * is `'category'`): + * + * The value should be the ordinal of the axis.data + * (based on `0`), the string value of the axis.data. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap) + * + * There is an example of double category axes: + * [Github Punchcard](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-punchCard) + * . + * + * + When a dimension corresponds to a time axis (type is `'time'`), + * the value can be: + * + * + a timestamp, like `1484141700832`, which represents a UTC time. + * + a date string, in one of the formats below: + * + a subset of + * [ISO 8601](http://www.ecma-international.org/ecma-262/5.1/#se + * c-15.9.1.15) + * , only including (all of these are treated as local time unless + * timezone is specified, which is consistent with + * [moment](https://momentjs.com/) + * ): + * + only part of year/month/date/time are specified: `'2012-03'`, + * `'2012-03-01'`, `'2012-03-01 05'`, `'2012-03-01 05:06'`. + * + separated by `"T"` or a space: `'2012-03-01T12:22:33.123'`, + * `'2012-03-01 12:22:33.123'`. + * + timezone specified: `'2012-03-01T12:22:33Z'`, `'2012-03-01T12:22:33+8000'`, + * `'2012-03-01T12:22:33-05:00'`. + * + other date string format (all of these are treated as local + * time): `'2012'`, `'2012-3-1'`, `'2012/3/1'`, `'2012/03/01'`, + * `'2009/6/12 2:00'`, `'2009/6/12 2:05:08'`, `'2009/6/12 2:05:08.123'`. + * + a JavaScript Date instance created by user: + * + Caution, when using a data string to create a Date instance, + * [browser differences and inconsistencies](http://dygraphs.com/date-formats.html) + * should be considered. + * + For example: In chrome, `new Date('2012-01-01')` is treated + * as a Jan 1st 2012 in UTC, while `new Date('2012-1-1')` and `new + * Date('2012/01/01')` are treated as Jan 1st 2012 in local timezone. + * In safari `new Date('2012-1-1')` is not supported. + * + So if you intent to perform `new Date(dateString)`, it is strongly + * recommended to use a time parse library (e.g., + * [moment](https://momentjs.com/) + * ), or use `echarts.number.parseDate`, or check + * [this](http://dygraphs.com/date-formats.html) + * . + * + * **Customize a data item:** + * + * When needing to customize a data item, it can be set as an object, + * where property `value` reprensent real value. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap) + * + * **Empty value:** + * + * `'-'` or `null` or `undefined` or `NaN` can be used to describe + * that a data item is not exists (ps：_not exist_ does not means + * its value is `0`). + * + * For example, line chart can break when encounter an empty value, + * and scatter chart do not display graphic elements for empty values. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data + */ + data?: ( + (void | number | string | SeriesHeatmap.DataObject)[] + | (void | number | string | SeriesHeatmap.DataObject)[][] + ); + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.name + */ + name?: string; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0 + */ + 0?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1 + */ + 1?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0 + */ + 0?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1 + */ + 1?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in heatmap. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in heatmap, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.silent + */ + silent?: boolean; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesHeatmap { + interface DataObject { + + /** + * Name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.name + */ + name?: string; + + /** + * Value of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.value + */ + value?: any[]; + + /** + * It is valid with + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * of 'cartesian2d' value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Style of a single data point. It is valid with + * [coordinateSystem](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.coordinateSystem) + * of 'cartesian2d' value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.heatmap.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-heatmap.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + } + } + } +} diff --git a/types/echarts/options/series/line.d.ts b/types/echarts/options/series/line.d.ts new file mode 100644 index 0000000000..7d9a546fae --- /dev/null +++ b/types/echarts/options/series/line.d.ts @@ -0,0 +1,17089 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **broken line chart** + * + * Broken line chart relates all the data points + * [symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbol) + * by broken lines, which is used to show the trend of data changing. + * It could be used in both + * [rectangular coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * and + * [polar coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Tip:** When + * [areaStyle](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle) + * is set, area chart will be drew. + * + * **Tip:** With + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap-piecewise) + * component, Broken line / area chart can have different colors on + * different sections, as below: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line + */ + interface SeriesLine { + + /** + * @default + * "line" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.name + */ + name?: string; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'polar'` + * + * Use polar coordinates, with + * [polarIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-bar.polarIndex) + * to assign the corresponding polar coordinate component. + * + * + * @default + * "cartesian2d" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [polar coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * to combine with, which is useful for multiple polar axes in one + * chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.polarIndex + */ + polarIndex?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data) + * , and the second parameter `params` is the rest parameters of + * data item. + * + * + * @default + * 4 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to show symbol. + * It would be shown during tooltip hover. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.showSymbol + */ + showSymbol?: boolean; + + /** + * Only work when main axis is `'category'` axis (`axis.type` + * is `'category'`). Optional values: + * + * + `'auto'`: Default value. + * Show all symbols if there is enough space. + * Otherwise follow the interval strategy with with + * [axisLabel.interval](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisLabel.interval) + * . + * + `true`: Show all symbols. + * + `false`: Follow the interval strategy with + * [axisLabel.interval](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisLabel.interval) + * . + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.showAllSymbol + */ + showAllSymbol?: boolean; + + /** + * Whether to enable the animation effect when mouse is on the symbol. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.hoverAnimation + */ + hoverAnimation?: boolean; + + /** + * Whether to enable highlighting chart when + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * is being hovered. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.legendHoverLink + */ + legendHoverLink?: boolean; + + /** + * If stack the value. + * On the same category axis, the series with the same `stack` name + * would be put on top of each other. + * + * The effect of the below example could be seen through stack switching + * of + * [toolbox](https://ecomfe.github.io/echarts-doc/public/en/option.html#toolbox) + * on the top right corner: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.stack + */ + stack?: string; + + /** + * The mouse style when mouse hovers on an element, the same as + * `cursor` property in `CSS`. + * + * + * @default + * "pointer" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.cursor + */ + cursor?: string; + + /** + * Whether to connect the line across null points. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.connectNulls + */ + connectNulls?: boolean; + + /** + * Whether to clip the overflowing part, which defaults to clip. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.clipOverflow + */ + clipOverflow?: boolean; + + /** + * Whether to show as a step line. + * It can be `true`, `false`. + * Or `'start'`, `'middle'`, `'end'`. + * Which will configure the turn point of step line. + * + * See the example using different `step` options: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.step + */ + step?: boolean | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "top" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally and + * move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual color, + * such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * The style of the symbol point of broken line. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle + */ + itemStyle?: { + /** + * Some properties like "normal" or "emphasis" are not documented. + * Please, write description for them + */ + [unknownProperty: string]: any; + + /** + * color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.color + */ + color?: string | Function; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * Line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * The style of area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle + */ + areaStyle?: { + + /** + * Fill 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.areaStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.color + */ + color?: string; + + /** + * Origin position of area. + * + * By default, the area between axis line and data will be the + * area to be filled. + * This config enables you to fill data to the max or min of + * the axis data. + * + * Valid values include: `'auto'` (default), `'start'`, `'end'`. + * + * + `'auto'` to fill between axis line to data; + * + `'start'` to fill between min axis value (when not `inverse`) + * to data; + * + `'end'` to fill between max axis value (when not `inverse`) + * to data; + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.origin + */ + origin?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.areaStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not be + * drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.areaStyle.opacity + */ + opacity?: number; + }; + + /** + * 图形的高亮样式。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + }; + + /** + * Whether to show as smooth curve. + * + * If is typed in `boolean`, then it means whether to enable smoothing. + * If is typed in `number`, valued from 0 to 1, then it means smoothness. + * A smaller value makes it less smooth. + * + * Please refer to + * [smoothMonotone](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.smoothMonotone) + * to change smoothing algorithm. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.smooth + */ + smooth?: boolean | number; + + /** + * Whether the broken line keep the monotonicity when it is smoothed. + * It can be set as `'x'`, `'y'` to keep the monotonicity on x axis + * or y axis. + * Or it can be set to be `'none'` to use non-monotone smoothing + * algorithm. + * + * From ECharts 4.0.3, + * we improved our default smoothing algorithm. + * The old algorithm can be used by setting `smoothMonotone` to + * be `'none'`. + * Here's the difference between old and new algorithm. + * In the following chart, old algorithm is in green color, and + * new algorithm is in red color. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * The old algorithm has many problems: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * Old algorithm uses the previous and next point to form control + * points' direction, while they are always horizontal (when the + * first dimension of data is monotone) or vertical (when the second + * dimension of data is monotone) in new algorithm. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * But new algorithm doesn't work with non-monotone data. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * So we suggest that default value of `smoothMonotone` be used + * in most situations. + * If data on Y axis is monotone, it should be set to be `'y'`. + * If data is non-monotone, it should be set to be `'none'` to use + * the old algorithm. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.smoothMonotone + */ + smoothMonotone?: string; + + /** + * The dowmsampling strategy used when the data size is much larger + * than pixel size. + * It will improve the performance when turned on. + * Defaults to be turned off, indicating that all the data points + * will be drawn. + * + * Options: + * + * + `'average'` Use average value of filter points + * + `'max'` Use maximum value of filter points + * + `'min'` Use minimum value of filter points + * + `'sum'` Use sum of filter points + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.sampling + */ + sampling?: string; + + /** + * `dimensions` can be used to define dimension info for `series.data` + * or `dataset.source`. + * + * Notice: if + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, we can provide dimension names in the first column/row + * of + * [dataset.source](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset.source) + * , and not need to specify `dimensions` here. + * But if `dimensions` is specified here, echarts will not retrieve + * dimension names from the first row/column of `dataset.source` + * any more. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * Each data item of `dimensions` can be: + * + * + `string`, for example, `'someName'`, which equals to `{name: + * 'someName'}`. + * + `Object`, where the attributes can be: + * + name: `string`. + * + type: `string`, supports: + * + `number` + * + `float`, that is, + * [Float64Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) + * + * + `int`, that is, + * [Int32Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) + * + * + `ordinal`, discrete value, which represents string generally. + * + `time`, time value, see + * [data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * to check the format of time value. + * + displayName: `string`, generally used in tooltip for dimension + * display. If not specified, use `name` by default. + * + * When `dimensions` is specified, the default `tooltip` will be + * displayed vertically, which is better to show diemsion names. + * Otherwise, `tooltip` will displayed only value horizontally. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.dimensions + */ + dimensions?: any[]; + + /** + * Define what is encoded to for each dimension of `data`. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * Attributes of encode are different according to the type of coordinate + * systtems. For + * [cartesian2d](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , `x` and `y` can be defined. For + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * , `radius` and `angle` can be defined. For + * [geo](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * , `lng` and `lat` can be defined. + * Attribute `tooltip` and `itemName` (data item name in tooltip) + * are always able to be defined. + * + * When + * [dimensions](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.dimensions) + * is used to defined name for a certain dimension, `encode` can + * refer the name directly. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * Specially, in \[custom series(~series-custom), some property + * in `encode`, corresponding to axis, can be set as null to make + * the series not controlled by the axis, that is, the series data + * will not be count in the extent of the axis, and the + * [dataZoom](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataZoom) + * on the axis will not filter the series. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.encode + */ + encode?: object; + + /** + * When + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * is used, `seriesLayoutBy` specifies whether the column or the + * row of `dataset` is mapped to the series, namely, the series + * is "layout" on columns or rows. Optional values: + * + * + 'column': by default, the columns of `dataset` are mapped the + * series. In this case, each column represents a dimension. + * + 'row'：the rows of `dataset` are mapped to the series. + * In this case, each row represents a dimension. + * + * Check this + * [example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=dataset-series-layout-by) + * . + * + * + * @default + * "column" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.seriesLayoutBy + */ + seriesLayoutBy?: string; + + /** + * If + * [series.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.data) + * is not specified, and + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * exists, the series will use `dataset`. + * `datasetIndex` specifies which dataset will be used. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.datasetIndex + */ + datasetIndex?: number; + + /** + * Data array of series, which can be in the following forms: + * + * Notice, if no `data` specified in series, and there is + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * in option, series will use the first + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * as its datasource. If `data` has been specified, + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * will not used. + * + * `series.datasetIndex` can be used to specify other + * [dataset](https://ecomfe.github.io/echarts-doc/public/en/option.html#dataset) + * . + * + * Basically, data is represented by a two-dimension array, like + * the example below, where each colum is named as a "dimension". + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + In + * [cartesian (grid)](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , "dimX" and "dimY" correspond to + * [xAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * and + * [yAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * repectively. + * + In + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * "dimX" and "dimY" correspond to + * [radiusAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#radiusAxis) + * 和 + * [angleAxis](https://ecomfe.github.io/echarts-doc/public/en/option.html#anbleAxis) + * repectively. + * + Other dimensions are optional, which can be used in other place. + * For example: + * + [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * can map one or more dimensions to viusal (color, symbol size + * ...). + * + [series.symbolSize](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.symbolSize) + * can be set as a callback function, where symbol size can be calculated + * by values of a certain dimension. + * + Values in other dimensions can be shown by + * [tooltip.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.formatter) + * or + * [series.label.formatter](https://ecomfe.github.io/echarts-doc/public/en/option.html#series.label.formatter) + * . + * + * Especially, when there is one and only one category axis (axis.type + * is `'category'`), data can be simply be represented by a one-dimension + * array, like: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * **Relationship between "value" and + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.type) + * ** + * + * + When a dimension corresponds to a value axis (axis.type + * is `'value'` or `'log'`): + * + * The value can be a `number` (like `12`) (can also be a number + * in a `string` format, like `'12'`). + * + * + When a dimension corresponds to a category axis (axis.type + * is `'category'`): + * + * The value should be the ordinal of the axis.data + * (based on `0`), the string value of the axis.data. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * There is an example of double category axes: + * [Github Punchcard](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-punchCard) + * . + * + * + When a dimension corresponds to a time axis (type is `'time'`), + * the value can be: + * + * + a timestamp, like `1484141700832`, which represents a UTC time. + * + a date string, in one of the formats below: + * + a subset of + * [ISO 8601](http://www.ecma-international.org/ecma-262/5.1/#se + * c-15.9.1.15) + * , only including (all of these are treated as local time unless + * timezone is specified, which is consistent with + * [moment](https://momentjs.com/) + * ): + * + only part of year/month/date/time are specified: `'2012-03'`, + * `'2012-03-01'`, `'2012-03-01 05'`, `'2012-03-01 05:06'`. + * + separated by `"T"` or a space: `'2012-03-01T12:22:33.123'`, + * `'2012-03-01 12:22:33.123'`. + * + timezone specified: `'2012-03-01T12:22:33Z'`, `'2012-03-01T12:22:33+8000'`, + * `'2012-03-01T12:22:33-05:00'`. + * + other date string format (all of these are treated as local + * time): `'2012'`, `'2012-3-1'`, `'2012/3/1'`, `'2012/03/01'`, + * `'2009/6/12 2:00'`, `'2009/6/12 2:05:08'`, `'2009/6/12 2:05:08.123'`. + * + a JavaScript Date instance created by user: + * + Caution, when using a data string to create a Date instance, + * [browser differences and inconsistencies](http://dygraphs.com/date-formats.html) + * should be considered. + * + For example: In chrome, `new Date('2012-01-01')` is treated + * as a Jan 1st 2012 in UTC, while `new Date('2012-1-1')` and `new + * Date('2012/01/01')` are treated as Jan 1st 2012 in local timezone. + * In safari `new Date('2012-1-1')` is not supported. + * + So if you intent to perform `new Date(dateString)`, it is strongly + * recommended to use a time parse library (e.g., + * [moment](https://momentjs.com/) + * ), or use `echarts.number.parseDate`, or check + * [this](http://dygraphs.com/date-formats.html) + * . + * + * **Customize a data item:** + * + * When needing to customize a data item, it can be set as an object, + * where property `value` reprensent real value. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * **Empty value:** + * + * `'-'` or `null` or `undefined` or `NaN` can be used to describe + * that a data item is not exists (ps：_not exist_ does not means + * its value is `0`). + * + * For example, line chart can break when encounter an empty value, + * and scatter chart do not display graphic elements for empty values. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data + */ + data?: ( + (void | string | number | SeriesLine.DataObject)[] + | (void | string | number | SeriesLine.DataObject)[][] + ); + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.valueDim) + * can be used to assign the dimension. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.name + */ + name?: string; + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.type + */ + type?: string; + + /** + * Available when using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.type) + * it is used to assign maximum value and minimum value + * in dimensions, it could be `0` (xAxis, radiusAxis), `1` + * (yAxis, angleAxis), and use the first value axis dimension + * by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.type) + * is assigned. + * It is used to state the dimension used to calculate maximum + * value or minimum value. + * It may be the direct name of a dimension, like `x`, or + * `angle` for line charts, or `open`, or `close` for candlestick + * charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, whose + * format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint / + * markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * 2. Assign coordinate position with + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.coord) + * attribute, in which `'min'`, `'max'`, `'average'` are supported + * for each dimension. + * + * 3. Use + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.type) + * attribute to mark the maximum and minimum values in the series, + * in which + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.valueDim) + * can be used to assign the dimension. + * + * 4. + * You may also create a mark line in Cartesian coordinate at + * a specific position in X or Y axis by assigning `xAxis` or + * `yAxis`. See + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * for example. + * + * When multiple attributes exist, priority is as the above + * order. + * + * You may also set the type of mark line through `type`, stating + * whether it is for the maximum value or average value. + * Likewise, dimensions can be assigned through `valueIndex`. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0 + */ + 0?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1 + */ + 1?: { + + /** + * Special label types, are used to label maximum value, + * minimum value and so on. + * + * **Options are:** + * + * + `'min'` maximum value. + * + `'max'` minimum value. + * + `'average'` average value. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.type + */ + type?: string; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be `0` (for xAxis, or radiusAxis), or `1` + * (for yAxis, or angleAxis). + * Dimension of the first numeric axis is used by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Works only when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markLine.data.type) + * is assigned. + * It is used to state the dimension used to calculate + * maximum value or minimum value. + * It may be the direct name of a dimension, like `x`, + * or `angle` for line charts, or `open`, or `close` + * for candlestick charts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.valueDim + */ + valueDim?: string; + + /** + * Coordinates of the starting point or ending point, + * whose format depends on the coordinate of the series. + * It can be `x`, and `y` for + * [rectangular coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, and `angle` for + * [polar coordinates](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * **Notice:** For axis with + * [axis.type](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAixs.type) + * `'category'`: + * + * + If coord value is `number`, it represents index + * of + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * . + * + If coord value is `string`, it represents concrete + * value in + * [axis.data](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.data) + * + * + * Please notice that in this case `xAxis.data` + * must not be written as \[number, number, + * + * + * + * \], but can only be written \[string, string, + * + * + * + * \]. + * Otherwise it is not able to be located by markPoint + * / markLine. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.coord + */ + coord?: any[]; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * 2. + * Specify the coordinate in data coordinate system (i.e., + * cartesian) using + * [coord](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.coord) + * , which can be also set as `'min'`, `'max'`, `'average'` + * (e.g, + * `coord: [23, 'min']`, or `coord: ['average', 'max']`)。 + * + * 1. + * Locate the point on the min value or max value of `series.data` + * using + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.type) + * , where + * [valueIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.valueIndex) + * or + * [valueDim](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markPoint.data.0.valueDim) + * can be used to specify the dimension on which the min, max + * or average are calculated. + * 2. + * If in cartesian, you can only specify `xAxis` or `yAxis` + * to define a mark area based on only X or Y axis, see sample + * [scatter-weight](https://ecomfe.github.io/echarts-examples/public/editor.html?c=scatter-weight) + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0 + */ + 0?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1 + */ + 1?: { + + /** + * Specify this item is on min or max or average value. + * + * **Options:** + * + * + `'min'` max value。 + * + `'max'` min value。 + * + `'average'` average value。 + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.type + */ + type?: string; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be `0` (means xAxis, radiusAxis) or + * `1` (means yAxis, angleAxis), using the dimension + * of the first axis by default. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.valueIndex + */ + valueIndex?: number; + + /** + * Specify the dimension on which min, max, average + * are calculated, available when + * [type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-.markArea.data.type) + * used. + * The value can be the name of the dimension (for example, + * the value can be `x`, `angle` in line chart, and + * `open`, `close` in candlestick). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.valueDim + */ + valueDim?: string; + + /** + * The format is \[start coordinate, end coordinate\], + * where the coordinate system can be `x`, `y` on + * [cartesian](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * , or `radius`, `angle` on + * [polar](https://ecomfe.github.io/echarts-doc/public/en/option.html#polar) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.coord + */ + coord?: any[]; + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in broken line graph. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in broken line graph, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.silent + */ + silent?: boolean; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "linear" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + + /** + * tooltip settings in this series. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip + */ + tooltip?: { + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, and + * `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: [width, + * height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, which + * can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse is in, + * which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.position + */ + position?: any[] | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which supports + * string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` and + * `{e}`, which stands for series name, data name and data value + * and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple series. + * In this time, series index can be refered as `{a0}`, `{a1}`, + * or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for different + * series types: + * + * + Line (area) charts, bar (column) charts, K charts: `{a}` + * for series name, `{b}` for category name, `{c}` for data + * value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` for + * data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for series + * name, `{b}` for data item name, `{c}` for data value, `{d}` + * for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as above. + * Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * **Note:** Using array to present all the parameters in ECharts + * 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, `ticket` + * and `htm` as introduced above can be used to update tooltip + * with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.formatter + */ + formatter?: Function | string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.borderColor + */ + borderColor?: string; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.padding + */ + padding?: number; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * + * > **Notice：**series.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + + namespace SeriesLine { + interface DataObject { + + /** + * The name of data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.name + */ + name?: string; + + /** + * The value of a single data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.value + */ + value?: number; + + /** + * Symbol of single data. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data) + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.symbol + */ + symbol?: string; + + /** + * single data 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`. + * + * + * @default + * 4 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of single data symbol. + * Note that when `symbol` is set to be `'arrow'` in `markLine`, + * `symbolRotate` value will be ignored, and compulsively use + * tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of single data 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * The style of the text of single data point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "top" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * The style of the symbol of single data point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle + */ + itemStyle?: { + + /** + * Bar color.. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.barBorderWidth + */ + barBorderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle + */ + itemStyle?: { + + /** + * Bar color.. + * + * + * @default + * "auto" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.color + */ + color?: string; + + /** + * The bodrder color of bar. + * + * + * @default + * '#000' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.barBorderColor + */ + barBorderColor?: string; + + /** + * The bodrder width of bar. + * defaults to have no border. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.barBorderWidth + */ + barBorderWidth?: number; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.itemStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * tooltip settings in this series data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip + */ + tooltip?: { + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The position of the tooltip's floating layer, which would + * follow the position of mouse by default. + * + * Options: + * + * + `Array` + * + * Display the position of tooltip's floating layer through + * array, which supports absolute position and relative + * percentage. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * + `Function` + * + * Callback function in the following form: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * **Parameters:** + * point: Mouse position. + * param: The same as formatter. + * dom: The DOM object of tooltip. + * rect: It is valid only when mouse is on graphic elements, + * which stands for a bounding box with `x`, `y`, `width`, + * and `height`. + * size: The size of dom echarts container. + * For example: `{contentSize: [width, height], viewSize: + * [width, height]}`. + * + * **Return:** + * Return value is an array standing for tooltip position, + * which can be absolute pixels, or relative percentage. + * Or can be an object, like `{left: 10, top: 30}`, or `{right: + * '20%', bottom: 40}`. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * Or: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * + `'inside'` + * + * Center position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'top'` + * + * Top position of the graphic element where the mouse is + * in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'left'` + * + * Left position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'right'` + * + * Right position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + `'bottom'` + * + * Bottom position of the graphic element where the mouse + * is in, which is only valid when + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'item'`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.position + */ + position?: any[] | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The content formatter of tooltip's floating layer which + * supports string template and callback function. + * + * **1\. String template** + * + * The template variables are `{a}`, `{b}`, `{c}`, `{d}` + * and `{e}`, which stands for series name, data name and + * data value and ect. When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is set to be `'axis'`, there may be data from multiple + * series. + * In this time, series index can be refered as `{a0}`, + * `{a1}`, or `{a2}`. + * + * `{a}`, `{b}`, `{c}`, `{d}` have different meanings for + * different series types: + * + * + Line (area) charts, bar (column) charts, K charts: + * `{a}` for series name, `{b}` for category name, `{c}` + * for data value, `{d}` for none; + * + * + Scatter (bubble) charts: `{a}` for series name, `{b}` + * for data name, `{c}` for data value, `{d}` for none; + * + * + Map: `{a}` for series name, `{b}` for area name, `{c}` + * for merging data, `{d}` for none; + * + * + Pie charts, gauge charts, funnel charts: `{a}` for + * series name, `{b}` for data item name, `{c}` for data + * value, `{d}` for percentage. + * + * **Example:** + * + * ``` + * formatter: '{b0}: {c0}
{b1}: {c1}' + * + * ``` + * + * **2\. Callback function** + * + * The format of callback function: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * The first parameter `params` is the data that the formatter + * needs. Its format is shown as follows: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * When + * [trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * is `'axis'`, or when tooltip is triggered by + * [axisPointer](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis.axisPointer) + * , `params` is the data array of multiple series. + * The content of each item of the array is the same as + * above. Besides, + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * **Note:** Using array to present all the parameters in + * ECharts 2.x is not supported anymore. + * + * The second parameter `ticket` is the asynchronous callback + * flag which should be used along with the third parameter + * `callback` when it is used. + * + * The third parameter `callback` is asynchronous callback. + * When the content of tooltip is acquired asynchronously, + * `ticket` and `htm` as introduced above can be used to + * update tooltip with callback. + * + * Example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.formatter + */ + formatter?: Function | string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The background color of tooltip's floating layer. + * + * + * @default + * "rgba(50,50,50,0.7)" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.backgroundColor + */ + backgroundColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border color of tooltip's floating layer. + * + * + * @default + * '#333' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.borderColor + */ + borderColor?: string; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The border width of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.borderWidth + */ + borderWidth?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The floating layer of tooltip space around content. + * The unit is px. + * Default values for each position are 5. + * And they can be set to different values with left, right, + * top, and bottom. + * + * Examples: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip) + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.padding + */ + padding?: number; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * The text syle of tooltip's floating layer. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle + */ + textStyle?: { + + /** + * text color. + * + * + * @default + * "#fff" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 14 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.line.data.tooltip.textStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.textStyle.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + + /** + * > **Notice：**series.data.tooltip only works when + * > [tooltip.trigger](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip.trigger) + * > is `'item'`. + * + * Extra CSS style for floating layer. + * The following is an example for adding shadow. + * + * ``` + * extraCssText: 'box-shadow: 0 0 3px rgba(0, 0, 0, 0.3);' + * + * ``` + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.data.tooltip.extraCssText + */ + extraCssText?: string; + }; + } + } + } +} diff --git a/types/echarts/options/series/lines.d.ts b/types/echarts/options/series/lines.d.ts new file mode 100644 index 0000000000..957acf0ac7 --- /dev/null +++ b/types/echarts/options/series/lines.d.ts @@ -0,0 +1,14937 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **Lines graph** + * + * It is used to draw the line data with the information about "from" + * and "to"; and it is applied fot drawing the air routes on map, which + * visualizes these routes. + * + * ECharts 2.x + * uses the `markLine` to draw the migrating effect, while in ECharts + * 3, the `lines` graph is recommended to be used. + * + * **Migrating example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines + */ + interface SeriesLines { + + /** + * @default + * "lines" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.name + */ + name?: string; + + /** + * The coordinate used in the series, whose options are: + * + * + `'cartesian2d'` + * + * Use a two-dimensional rectangular coordinate (also known as Cartesian + * coordinate), with + * [xAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.xAxisIndex) + * and + * [yAxisIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.yAxisIndex) + * to assign the corresponding axis component. + * + * + `'geo'` + * + * Use geographic coordinate, with + * [geoIndex](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.geoIndex) + * to assign the corresponding geographic coordinate components. + * + * + * @default + * "geo" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.coordinateSystem + */ + coordinateSystem?: string; + + /** + * Index of + * [x axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#xAxis) + * to combine with, which is useful for multiple x axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.xAxisIndex + */ + xAxisIndex?: number; + + /** + * Index of + * [y axis](https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis) + * to combine with, which is useful for multiple y axes in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.yAxisIndex + */ + yAxisIndex?: number; + + /** + * Index of + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * to combine with, which is useful for multiple geographic axes + * in one chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.geoIndex + */ + geoIndex?: number; + + /** + * If draw as polyline. + * + * Default to be `false`. Can only draw a two end straight line. + * + * If it is set true, + * [data.coords](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.coords) + * can have more than two coord to draw a polyline. + * It is useful when visualizing GPS track data. See example + * [lines-bus](https://ecomfe.github.io/echarts-examples/public/editor.html?c=lines-bmap-bus) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.polyline + */ + polyline?: boolean; + + /** + * The setting about special effect of lines. + * + * **Tips:** All the graphs with trail effect should be put on a + * individual layer, which means that + * [zlevel](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.zlevel) + * need to be different with others. And the animation ( + * [animation](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animation) + * : false) of this layer is suggested to be turned off at the meanwhile. + * Otherwise, other graphic elements in other series and the + * [label](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label) + * of animation would produce unnecessary ghosts. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect + */ + effect?: { + + /** + * Whether to show special effect. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.show + */ + show?: boolean; + + /** + * The duration of special effect, which unit is second. + * + * + * @default + * 4 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.period + */ + period?: number; + + /** + * Effect animation delay. + * Can be number or callback function. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.delay + */ + delay?: Function | number; + + /** + * If symbol movement of special effect has a constant speed, + * which unit is pixel per second. + * [period](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.period) + * will be ignored if `constantSpeed` is larger than 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.constantSpeed + */ + constantSpeed?: number; + + /** + * The symbol of special effect. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.effect) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.effect) + * + * The above example uses a custom path of plane shape. + * + * **Tip:** Ahe angle of symbol changes as the tangent of track + * changes. + * If you use a custom path, you should make sure that the path + * shape are upward oriented. + * It would ensure that the symbol will always move toward the + * right moving direction when the symbol moves along the track. + * + * + * @default + * "circle" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.symbol + */ + symbol?: string; + + /** + * The symbol size of special effect, which could be set as + * single number such as `10`. + * What's more, arrays could be used to decribe the width and + * height respectively. + * For instance, `[20, 10]` indicates `20` for width and `10` + * for height. + * + * + * @default + * 3 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.symbolSize + */ + symbolSize?: any[] | number; + + /** + * The color of special effect symbol, which defaults to be + * same with + * [lineStyle.color](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.color) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.color + */ + color?: string; + + /** + * The length of trail of special effect. + * The values from 0 to 1 could be set. + * Trail would be longer as the the value becomes larger. + * + * + * @default + * 0.2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.trailLength + */ + trailLength?: number; + + /** + * Whether to loop the special effect animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.effect.loop + */ + loop?: boolean; + }; + + /** + * Whether to enable the optimization of large-scale lines graph. + * It could be enabled when there is a particularly large number + * of data(>=5k) . + * + * After being enabled, + * [largeThreshold](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.largeThreshold) + * can be used to indicate the minimum number for turning on the + * optimization. + * + * The style of a single data item can't be customized + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.large + */ + large?: boolean; + + /** + * The threshold enabling the drawing optimization. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.largeThreshold + */ + largeThreshold?: number; + + /** + * Symbol type at the two ends of the line. + * It can be an array for two ends, or assigned seperately. See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-line.markLine.data.0.symbol) + * for more format information. + * + * + * @default + * "none" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @default + * 10 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.symbolSize + */ + symbolSize?: any[] | number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle + */ + lineStyle?: { + + /** + * Line color. Color is taken from + * [option.color Palette](https://ecomfe.github.io/echarts-doc/public/en/option.html#color) + * by default. + * + * Supports callback functions, in the form of: + * + * ``` + * (params: Object) => Color + * + * ``` + * + * Input parameters are `seriesIndex`, `dataIndex`, `data`, + * `value`, and etc. of data item. + * + * > 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.lineStyle) + * + * + * @default + * "self-adaptive" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.opacity + */ + opacity?: number; + + /** + * The curveness of edge. + * The values from 0 to 1 could be set. + * The curveness would be larger as the the value becomes larger. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lineStyle.curveness + */ + curveness?: number; + }; + + /** + * Label settings. Does not work when + * [polyline](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.polyline) + * is `true`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.show + */ + show?: boolean; + + /** + * the position of label, options: + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * Emphasis style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.lineStyle.opacity + */ + opacity?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.show + */ + show?: boolean; + + /** + * the position of label, options: + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * `progressive` specifies the amount of graphic elements that can + * be rendered within a frame (about 16ms) if "progressive rendering" + * enabled. + * + * When data amount is from thousand to more than 10 million, it + * will take too long time to render all of the graphic elements. + * Since ECharts 4, "progressive rendering" is supported in its + * workflow, which processes and renders data chunk by chunk alone + * with each frame, avoiding to block the UI thread of the browser. + * + * + * @default + * 400 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.progressive + */ + progressive?: number; + + /** + * If current data amount is over the threshold, "progressive rendering" + * is enabled. + * + * + * @default + * 3000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.progressiveThreshold + */ + progressiveThreshold?: number; + + /** + * The data set of lines. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data + */ + data?: SeriesLines.DataObject[]; + + /** + * Mark point in a chart. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint + */ + markPoint?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * + * @default + * "pin" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.symbol + */ + symbol?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-.data) + * , and the second parameter `params` is the rest parameters + * of data item. + * + * + * @default + * 50 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.symbolSize + */ + symbolSize?: any[] | Function | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.silent + */ + silent?: boolean; + + /** + * Label of mark point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @default + * "inside" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.offset + */ + offset?: any[]; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array for mark points, each of which is an object. + * Here are some ways to assign mark point position. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * **For example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data + */ + data?: { + + /** + * Mark point name. + * + * + * @default + * '' + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.name + */ + name?: string; + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.value + */ + value?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.symbol + */ + symbol?: string; + + /** + * 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.symbolSize + */ + symbolSize?: any[] | number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Mark point style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint.data.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.data.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markPoint) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * prefix + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markPoint.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Use a line in the chart to illustrate. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine + */ + markLine?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.silent + */ + silent?: boolean; + + /** + * Symbol type at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * See + * [data.symbol](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbol) + * for more format information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.symbol + */ + symbol?: any[] | string; + + /** + * Symbol size at the two ends of the mark line. + * It can be an array for two ends, or assigned seperately. + * + * **Attention:** You cannot assgin width and height seperately + * as normal `symbolSize`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Precison of marking line value, which is useful when displaying + * average value mark line. + * + * + * @default + * 2 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.precision + */ + precision?: number; + + /** + * Mark line text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + + /** + * Mark line style. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.lineStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Data array of marking line. + * Every array item can be an array of one or two values, representing + * starting and ending point of the line, and every item is + * an object. + * Here are several ways to assign the positions of starting + * and ending point. + * + * 1. Assign coordinate according to container with + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.y) + * attribute, in which pixel values and percentage are supported. + * + * When multiple attributes exist, priority is as the above + * order. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data + */ + data?: { + + /** + * Data of the starting point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0 + */ + 0?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.value + */ + value?: number; + + /** + * Symbol of starting point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbol + */ + symbol?: string; + + /** + * starting point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of starting point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of starting point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.0.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + + /** + * Data of the ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1 + */ + 1?: { + + /** + * X position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.x + */ + x?: number; + + /** + * Y position according to container, in pixel. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.y + */ + y?: number; + + /** + * Label value, which can be ignored. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.value + */ + value?: number; + + /** + * Symbol of ending point. + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1) + * + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.symbol + */ + symbol?: string; + + /** + * ending point 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`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.symbolSize + */ + symbolSize?: any[] | number; + + /** + * Rotate degree of ending point symbol. + * Note that when `symbol` is set to be `'arrow'` in + * `markLine`, `symbolRotate` value will be ignored, + * and compulsively use tangent angle. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.symbolRotate + */ + symbolRotate?: number; + + /** + * Whether to keep aspect for symbols in the form of + * `path://`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.symbolKeepAspect + */ + symbolKeepAspect?: boolean; + + /** + * Offset of ending point 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.symbolOffset + */ + symbolOffset?: any[]; + + /** + * Line style of this data item, which will be merged + * with `lineStyle` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to + * 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.curveness + */ + curveness?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.lineStyle.emphasis) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.lineStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from + * 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.lineStyle.emphasis.curveness + */ + curveness?: number; + }; + }; + + /** + * Label of this data item, which will be merged with + * `label` of starting point and ending point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label + */ + label?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.formatter + */ + formatter?: Function | string; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether show label or not. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * Positions of labels can be: + * + * + `'start'` starting point of the line. + * + `'middle'` middle point of the line. + * + `'end'` ending point of the line. + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.emphasis.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.data.1.label.emphasis.formatter + */ + formatter?: Function | string; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markLine) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markLine.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * Used to mark an area in chart. + * For example, mark a time interval. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea + */ + markArea?: { + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to + * mouse events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.silent + */ + silent?: boolean; + + /** + * Label in mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value represents + * rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive value + * represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as visual + * color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + + /** + * Style of the mark area. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, or `'dotted'`. + * `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to that of + * `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * The scope of the area is defined by `data`, which is an array + * with two item, representing the left-top point and the right-bottom + * point of rectangle area. + * Each item can be defined as follows: + * + * 1. + * Specify the coordinate in screen coordinate system using + * [x](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.x) + * , + * [y](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.y) + * , where the unit is pixel (e.g., + * the value is `5`), or percent (e.g., + * the value is `'35%'`). + * + * The priority follows as above if more than one above definition + * used. + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data + */ + data?: { + + /** + * Specify the left-top point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0 + */ + 0?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.0.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.0.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + + /** + * Specify the right-bottom point. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1 + */ + 1?: { + + /** + * x value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.x + */ + x?: number; + + /** + * y value on screen coordinate system, can be pixel + * number (like `5`), or percent value (like `'20%'`). + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.y + */ + y?: number; + + /** + * value of the item, not necessary. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.value + */ + value?: number; + + /** + * Style of the item. + * `itemStyle` of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle + */ + itemStyle?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.color + */ + color?: string; + + /** + * border color, whose format is similar to that + * of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.itemStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of + * shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.opacity + */ + opacity?: number; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis + */ + emphasis?: { + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.color + */ + color?: string; + + /** + * border color, whose format is similar to + * that of `color`. + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderColor + */ + borderColor?: string; + + /** + * border width. + * No border when it is set to be 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border type, which can be `'solid'`, `'dashed'`, + * or `'dotted'`. `'solid'` by default. + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.borderType + */ + borderType?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with + * `shadowColor`,`shadowOffsetX`, `shadowOffsetY` + * to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.itemStyle.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. + * Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction + * of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component + * will not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.itemStyle.emphasis.opacity + */ + opacity?: number; + }; + }; + + /** + * Label style of the item. + * Label style of start point and end point will be + * merged together. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned as + * visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis + */ + emphasis?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.show + */ + show?: boolean; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * + 'top' + * + * + 'left' + * + 'right' + * + 'bottom' + * + 'inside' + * + 'insideLeft' + * + 'insideRight' + * + 'insideTop' + * + 'insideBottom' + * + 'insideTopLeft' + * + 'insideBottomLeft' + * + 'insideTopRight' + * + 'insideBottomRight' + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/view.html?c=doc-example/label-position) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.position + */ + position?: any[] | string; + + /** + * Distance to the host graphic element. + * Works when position is string value (like + * `'top'`、`'insideRight'`). + * + * See: + * [label position](https://ecomfe.github.io/echarts-examples/public/editor.html?c=doc-example/label-position) + * . + * + * + * @default + * 5 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.distance + */ + distance?: number; + + /** + * Rotate label, from -90 degree to 90, positive + * value represents rotate anti-clockwise. + * + * See: + * [label rotation](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-label-rotation) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rotate + */ + rotate?: number; + + /** + * Whether to move text slightly. + * For example: `[30, 40]` means move `30` horizontally + * and move `40` vertically. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.offset + */ + offset?: any[]; + + /** + * text color. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will assigned + * as visual color, such as series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this + * `rich` property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', + * ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea.data.1.label.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * If set as `'auto'`, the color will + * assigned as visual color, such as + * series color. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.data.1.label.emphasis.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + }; + }; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger + * than threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback + * function for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports + * callback function for different data to have different animation + * effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.markArea) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.markArea.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + }; + + /** + * `zlevel` value of all graghical elements in lines graph. + * + * `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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.zlevel + */ + zlevel?: number; + + /** + * `z` value of all graghical elements in lines graph, 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.z + */ + z?: number; + + /** + * Whether to ignore mouse events. + * Default value is false, for triggering and responding to mouse + * events. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.silent + */ + silent?: boolean; + + /** + * Whether to enable animation. + * + * + * @default + * "true" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animation + */ + animation?: boolean; + + /** + * Whether to set graphic number threshold to animation. + * Animation will be disabled when graphic number is larger than + * threshold. + * + * + * @default + * 2000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationThreshold + */ + animationThreshold?: number; + + /** + * Duration of the first animation, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines) + * + * + * @default + * 1000 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationDuration + */ + animationDuration?: Function | number; + + /** + * Easing method used for the first animation. + * Varied easing effects can be found at + * [easing effect example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=line-easing) + * . + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationEasing + */ + animationEasing?: string; + + /** + * Delay before updating the first animation, which supports callback + * function for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationDelay + */ + animationDelay?: Function | number; + + /** + * Time for animation to complete, which supports callback function + * for different data to have different animation effect: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines) + * + * + * @default + * 300 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationDurationUpdate + */ + animationDurationUpdate?: Function | number; + + /** + * Easing method used for animation. + * + * + * @default + * "cubicOut" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationEasingUpdate + */ + animationEasingUpdate?: string; + + /** + * Delay before updating animation, which supports callback function + * for different data to have different animation effect. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines) + * + * See + * [this example](https://ecomfe.github.io/echarts-examples/public/editor.html?c=bar-animation-delay) + * for more information. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.animationDelayUpdate + */ + animationDelayUpdate?: Function | number; + } + + namespace SeriesLines { + interface DataObject { + + /** + * the name of data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.name + */ + name?: string; + + children: [DataObject]; + + /** + * An array includes two ore more than two coordinates. + * Each coordinate could be `[x, y]` in + * [rectangular coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#grid) + * and `[lng, lat]` in + * [geographic coordinate](https://ecomfe.github.io/echarts-doc/public/en/option.html#geo) + * . + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.coords + */ + coords?: any[]; + + /** + * The line style of this data item. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will not + * be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.lineStyle.curveness + */ + curveness?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.show + */ + show?: boolean; + + /** + * the position of label, options: + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` property. + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when using + * background image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis + */ + emphasis?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.lineStyle) + * + * + * @default + * "#000" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.color + */ + color?: string; + + /** + * line width. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.width + */ + width?: number; + + /** + * line type. + * + * Options are: + * + * + `'solid'` + * + `'dashed'` + * + `'dotted'` + * + * + * @default + * "solid" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.type + */ + type?: string; + + /** + * Size of shadow blur. + * This attribute should be used along with `shadowColor`,`shadowOffsetX`, + * `shadowOffsetY` to set shadow to component. + * + * For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.lineStyle) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow color. Support same format as `color`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.shadowColor + */ + shadowColor?: string; + + /** + * Offset distance on the horizontal direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Offset distance on the vertical direction of shadow. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * Opacity of the component. + * Supports value from 0 to 1, and the component will + * not be drawn when set to 0. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.opacity + */ + opacity?: number; + + /** + * Edge curvature, which supports value from 0 to 1. + * The larger the value, the greater the curvature. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.lineStyle.curveness + */ + curveness?: number; + }; + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label + */ + label?: { + + /** + * Whether to show label. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.show + */ + show?: boolean; + + /** + * the position of label, options: + * + * + `'start'` + * + `'middle'` + * + `'end'` + * + * + * @default + * "end" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.position + */ + position?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.formatter + */ + formatter?: Function | string; + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * `width` or `height` can be specified when using background + * image, or auto adapted by default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.textShadowOffsetY + */ + textShadowOffsetY?: number; + + /** + * "Rich text styles" can be defined in this `rich` + * property. For example: + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label) + * + * For more details, see + * [Rich Text](https://ecomfe.github.io/echarts-doc/public/en/option.htmltutorial.html#Rich%20Text) + * please. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich + */ + rich?: { + + /** + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E + */ + [userStyle: string]: { + + /** + * text color. + * + * + * @default + * ""#fff"" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.color + */ + color?: string; + + /** + * font style + * + * Options are: + * + * + `'normal'` + * + `'italic'` + * + `'oblique'` + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontStyle + */ + fontStyle?: string; + + /** + * font thick weight + * + * Options are: + * + * + `'normal'` + * + `'bold'` + * + `'bolder'` + * + `'lighter'` + * + 100 | 200 | 300 | 400... + * + * + * @default + * "normal" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontWeight + */ + fontWeight?: string; + + /** + * font family + * + * Can also be 'serif' , 'monospace', ... + * + * + * @default + * "sans-serif" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontFamily + */ + fontFamily?: string; + + /** + * font size + * + * + * @default + * 12 + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.fontSize + */ + fontSize?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.align + */ + align?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.verticalAlign + */ + verticalAlign?: string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.lineHeight + */ + lineHeight?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E) + * + * `width` or `height` can be specified when + * using background image, or auto adapted by + * default. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.backgroundColor + */ + backgroundColor?: object | string; + + /** + * Border color of the text fregment. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderColor + */ + borderColor?: string; + + /** + * Border width of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderWidth + */ + borderWidth?: number; + + /** + * Border radius of the text fregment. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.borderRadius + */ + borderRadius?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.padding + */ + padding?: any[] | number; + + /** + * Shadow color of the text block. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowColor + */ + shadowColor?: string; + + /** + * Show blur of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowBlur + */ + shadowBlur?: number; + + /** + * Shadow X offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetX + */ + shadowOffsetX?: number; + + /** + * Shadow Y offset of the text block. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.shadowOffsetY + */ + shadowOffsetY?: number; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.width + */ + width?: number | string; + + /** + * 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://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.height + */ + height?: number | string; + + /** + * Storke color of the text. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderColor + */ + textBorderColor?: string; + + /** + * Storke line width of the text. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textBorderWidth + */ + textBorderWidth?: number; + + /** + * Shadow color of the text itself. + * + * + * @default + * "transparent" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowColor + */ + textShadowColor?: string; + + /** + * Shadow blue of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowBlur + */ + textShadowBlur?: number; + + /** + * Shadow X offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetX + */ + textShadowOffsetX?: number; + + /** + * Shadow Y offset of the text itself. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.emphasis.label.rich.%3Cuser%20defined%20style%20name%3E.textShadowOffsetY + */ + textShadowOffsetY?: number; + }; + }; + }; + }; + } + } + } +} diff --git a/types/echarts/options/series/map.d.ts b/types/echarts/options/series/map.d.ts new file mode 100644 index 0000000000..12da2b5697 --- /dev/null +++ b/types/echarts/options/series/map.d.ts @@ -0,0 +1,16406 @@ +declare namespace echarts { + namespace EChartOption { + /** + * **Map.** + * + * Map is maily used in the visulization of geographic area data, which + * can be used with + * [visualMap](https://ecomfe.github.io/echarts-doc/public/en/option.html#visualMap) + * component to visualize the datas such as population distribution + * density in diffrent areas. + * + * Series of same + * [map type](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map.map) + * will show in one map. + * At this point, the configuration of the first series will be used + * for the map configuration. + * + * **Example:** + * + * [see doc](https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map) + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map + */ + interface SeriesMap { + + /** + * @default + * "map" + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map.type + */ + type?: string; + + /** + * Component ID, not specified by default. + * If specified, it can be used to refer the component in option + * or API. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map.id + */ + id?: string; + + /** + * Series name used for displaying in + * [tooltip](https://ecomfe.github.io/echarts-doc/public/en/option.html#tooltip) + * and filtering with + * [legend](https://ecomfe.github.io/echarts-doc/public/en/option.html#legend) + * , or updaing data and configuration with `setOption`. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-map.name + */ + name?: string; + + /** + * Map charts. + * + * Due to the increase of fineness of map, ECharts 3 doesn't include + * map data by default for package size consideration. + * You may find map files you need on + * [map download page](http://ecomfe.github.io/echarts-builder-web/map3.html + * ) + * and then include and register them in ECharts. + * + * Two formats of map data are provided in ECharts, one of which + * can be included in `