From 4ab95bd255d2c56c04fb52d6e5a0dcec34840238 Mon Sep 17 00:00:00 2001 From: bangbang93 Date: Thu, 5 Jul 2018 11:28:59 +0800 Subject: [PATCH 001/271] fix mockjs.Random.string() mockjs.Random.string() can be called without arguments. --- types/mockjs/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/mockjs/index.d.ts b/types/mockjs/index.d.ts index a0ca673b0a..9be645b791 100644 --- a/types/mockjs/index.d.ts +++ b/types/mockjs/index.d.ts @@ -58,7 +58,7 @@ declare namespace mockjs { character(pool?: S): S; // Random.string - string(pool: S | N, min?: N, max?: N): S; + string(pool?: S | N, min?: N, max?: N): S; // Random.range range(start?: N, stop?: N, step?: N): N; From fbe427753b27e80d2866bd1d5d92b8f5b8891336 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Tue, 16 Oct 2018 10:05:50 -0500 Subject: [PATCH 002/271] Added @disabled testhook --- types/nightwatch/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index b6930fe90a..30a7e491e0 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -2173,6 +2173,7 @@ export interface NightwatchTestHooks { after?: NightwatchTestHook; beforeEach?: NightwatchTestHook; afterEach?: NightwatchTestHook; + '@disabled'?: boolean; } export type NightwatchTests = NightwatchTestFunctions | NightwatchTestHooks; From 4b0e2344274d46ca98270cc9a653e0b0fdc49593 Mon Sep 17 00:00:00 2001 From: xtrimsystems Date: Sat, 20 Oct 2018 21:51:02 +0200 Subject: [PATCH 003/271] Added value object MotorPins for pins in MotorOption, added class Motors and update SensorOption to use new attribute enabled --- types/johnny-five/index.d.ts | 31 +++++++++++++++++++++++--- types/johnny-five/johnny-five-tests.ts | 5 +++++ 2 files changed, 33 insertions(+), 3 deletions(-) diff --git a/types/johnny-five/index.d.ts b/types/johnny-five/index.d.ts index eafa4038de..7fb54a53d2 100644 --- a/types/johnny-five/index.d.ts +++ b/types/johnny-five/index.d.ts @@ -3,6 +3,7 @@ // Definitions by: Toshiya Nakakura // Zoltan Ujvary // Simon Colmer +// XtrimSystems // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -514,9 +515,16 @@ export class Motion { on(event: "calibrated", cb: () => void): this; } +export interface MotorPins { + pwm: number; + dir: number; + cdir?: number; + brake?:number; +} + export interface MotorOption { - pins: any; - current?: any; + pins: MotorPins; + current?: SensorOption; invertPWM?: boolean; address?: number; controller?: string; @@ -540,6 +548,22 @@ export declare class Motor { release(): void; } +export declare class Motors { + constructor(option: Array | MotorOption[]); + + readonly isOn: boolean; + + forward(speed: number): void; + fwd(speed: number): void; + reverse(speed: number): void; + rev(speed: number): void; + start(): void; + start(speed: number): void; + stop(): void; + brake(): void; + release(): void; +} + export interface OrientiationOption { controller?: string; freq?: number; @@ -625,7 +649,7 @@ export declare class Ping { export declare interface ProximityOption { pin: number | string; controller: string; -} +} export declare interface ProximityData { cm: number; @@ -665,6 +689,7 @@ export interface SensorOption { pin: number | string; freq?: boolean; threshold?: number; + enabled?: boolean; } export declare class Sensor { diff --git a/types/johnny-five/johnny-five-tests.ts b/types/johnny-five/johnny-five-tests.ts index b2dd24904e..9d2b117344 100644 --- a/types/johnny-five/johnny-five-tests.ts +++ b/types/johnny-five/johnny-five-tests.ts @@ -155,6 +155,11 @@ board.on('ready', function(){ } }); + var motors = new five.Motors([ + { controller: 'PCA9685', pins: { pwm: 4, dir: 6 }}, + { controller: 'PCA9685', pins: { pwm: 5, dir: 7 }} + ]); + var piezo = new five.Piezo(3); // Plays a song From ea89485ed31827b073360568d9eca34e6401822a Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 09:44:07 -0500 Subject: [PATCH 004/271] Added Enhanced Page Objects Moved common functions for API and Page Objects to SharedFunctions --- types/nightwatch/index.d.ts | 778 +++++++++++++++++++----------------- 1 file changed, 409 insertions(+), 369 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index 30a7e491e0..eb084b828e 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -775,41 +775,13 @@ export interface NightwatchKeys { "COMMAND": string; } -export interface NightwatchAPI { +export interface NightwatchAPI extends SharedFunctions { assert: NightwatchAssertions; expect: Expect; verify: NightwatchAssertions; - /** - * Clear a textarea or a text input element's value. Uses elementIdValue protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.clearValue('input[type=text]'); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - */ - clearValue(selector: string, callback?: () => void): this; - - /** - * Simulates a click event on the given DOM element. Uses elementIdClick protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.click("#main ul li a.first"); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - */ - click(selector: string, callback?: () => void): this; - /** * Close the current window. This can be useful when you're working with multiple windows open (e.g. an OAuth login). Uses window protocol command. * @@ -867,26 +839,6 @@ export interface NightwatchAPI { */ end(callback?: () => void): this; - /** - * Retrieve the value of an attribute for a given DOM element. Uses elementIdAttribute protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.getAttribute("#main ul li a.first", "href", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, "#home"); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param attribute: The attribute name to inspect. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The value of the attribute - */ - getAttribute(selector: string, attribute: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** * Retrieve a single cookie visible to the current page. The cookie is returned as a cookie JSON object, as defined here. * Uses cookie protocol command. @@ -924,87 +876,6 @@ export interface NightwatchAPI { */ getCookies(callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** - * Retrieve the value of a css property for a given DOM element. Uses elementIdCssProperty protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.getCssProperty("#main ul li a.first", "display", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, 'inline'); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param cssProperty: The CSS property to inspect. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The value of the css property - */ - getCssProperty(selector: string, cssProperty: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - - /** - * Determine an element's size in pixels. Uses elementIdSize protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.getElementSize("#main ul li a.first", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value.width, 500); - * this.assert.equal(result.value.height, 20); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The width and height of the element in pixels - */ - getElementSize(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - - /** - * Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page. - * The element's coordinates are returned as a JSON object with x and y properties. Uses elementIdLocation protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.getLocation("#main ul li a.first", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value.x, 200); - * this.assert.equal(result.value.y, 200); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The X and Y coordinates for the element on the page - */ - getLocation(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - - /** - * Determine an element's location on the screen once it has been scrolled into view. Uses elementIdLocationInView protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.getLocationInView("#main ul li a.first", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value.x, 200); - * this.assert.equal(result.value.y, 200); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The X and Y coordinates for the element on the page. - */ - getLocationInView(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** * Gets a log from selenium * @@ -1040,44 +911,6 @@ export interface NightwatchAPI { */ getLogTypes(callback?: (result: NightwatchCallbackResult) => void): this; - /** - * Query for an element's tag name. Uses elementIdName protocol command. - * - * Usage: - * ``` - * this.demoTest = function (client) { - * client.getTagName("#main ul li .first", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, "a"); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The element's tag name, as a lowercase string. - */ - getTagName(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - - /** - * Returns the visible text for the element. Uses elementIdText protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.getText("#main ul li a.first", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, "nightwatchjs.org"); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The element's visible text. - */ - getText(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** * Returns the title of the current page. Uses title protocol command. * @@ -1095,25 +928,6 @@ export interface NightwatchAPI { */ getTitle(callback?: (this: NightwatchAPI, result?: string) => void): this; - /** - * Returns a form element current value. Uses elementIdValue protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.getValue("form.login input[type=text]", function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, "enter username"); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - * @returns The element's value. - */ - getValue(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** * This command is an alias to url and also a convenience method when called without any arguments in the sense that it performs a call to .url() with passing the value of launch_url * field from the settings file. Uses url protocol command. @@ -1162,24 +976,6 @@ export interface NightwatchAPI { */ isLogAvailable(typeString: string, callback?: (result: NightwatchCallbackResult) => void): this; - /** - * Determine if an element is currently displayed. Uses elementIdDisplayed protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.isVisible('#main', function(result) { - * this.assert.equal(typeof result, "object"); - * this.assert.equal(result.status, 0); - * this.assert.equal(result.value, true); - * }); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - */ - isVisible(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; - /** * Maximizes the current window. * @@ -1193,22 +989,6 @@ export interface NightwatchAPI { */ maximizeWindow(callback?: (result: NightwatchCallbackResult) => void): this; - /** - * Move the mouse by an offset of the specified element. Uses moveTo protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.moveToElement('#main', 10, 10); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param xoffset: X offset to move to, relative to the top-left corner of the element. - * @param yoffset: Y offset to move to, relative to the top-left corner of the element. - * @param callback: Optional callback function to be called when the command finishes. - */ - moveToElement(selector: string, xoffset: number, yoffset: number, callback?: (result: NightwatchCallbackResult) => void): this; - /** * Suspends the test for the given time in milliseconds. If the milliseconds argument is missing it will suspend the test indefinitely * @@ -1368,30 +1148,6 @@ export interface NightwatchAPI { */ setCookie(cookie: any, callback?: () => void): this; - /** - * Sends some text to an element. Can be used to set the value of a form element or to send a sequence of key strokes to an element. Any UTF-8 character may be specified. - * An object map with available keys and their respective UTF-8 characters, as defined on W3C WebDriver draft spec (http://www.w3.org/TR/webdriver/#character-types), - * is loaded onto the main Nightwatch instance as client.Keys. - * - * Usage: - * ``` - * // send some simple text to an input - * this.demoTest = function (browser) { - * browser.setValue('input[type=text]', 'nightwatch'); - * }; - * - * // - * // send some text to an input and hit enter. - * this.demoTest = function (browser) { - * browser.setValue('input[type=text]', ['nightwatch', browser.Keys.ENTER]); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param inputValue: The text to send to the element or key strokes. - * @param callback: Optional callback function to be called when the command finishes. - */ - setValue(selector: string, inputValue: string, callback?: () => void): this; - /** * Sets the current window position. * @@ -1407,20 +1163,6 @@ export interface NightwatchAPI { */ setWindowPosition(OffsetX: number, OffsetY: number, callback?: () => void): this; - /** - * Submit a FORM element. The submit command may also be applied to any element that is a descendant of a FORM element. Uses submit protocol command. - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.submitForm('form.login'); - * }; - * ``` - * @param selector: The CSS/Xpath selector used to locate the element. - * @param callback: Optional callback function to be called when the command finishes. - */ - submitForm(selector: string, callback?: () => void): this; - /** * Change focus to another window. The window to change focus to may be specified by its server assigned window handle, or by the value of its name attribute. * To find out the window handle use window_handles protocol action @@ -1455,116 +1197,6 @@ export interface NightwatchAPI { */ urlHash(hash: string): this; - /** - * Opposite of waitForElementPresent. Waits a given time in milliseconds for an element to be not present (i.e. removed) in the page before performing any other commands - * or assertions. If the element is still present after the specified amount of time, the test fails. You can change the polling interval by defining - * a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in your external globals file. - * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.waitForElementNotPresent('#dialog', 1000); - * }; - * ``` - * @param selector: The selector (CSS / Xpath) used to locate the element. - * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. - * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. - * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. - * @param callback: Optional callback function to be called when the command finishes. - * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time - * (e.g. Element %s was not in the page for %d ms). - */ - waitForElementNotPresent(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; - - /** - * Opposite of waitForElementVisible. Waits a given time in milliseconds for an element to be not visible (i.e. hidden but existing) in the page before performing - * any other commands or assertions. If the element fails to be hidden in the specified amount of time, the test fails. You can change the polling interval by - * defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in your external globals file. - * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.waitForElementNotVisible('#dialog', 1000); - * }; - * ``` - * @param selector: The selector (CSS / Xpath) used to locate the element. - * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. - * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. - * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. - * @param callback: Optional callback function to be called when the command finishes. - * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time - * (e.g. Element %s was not in the page for %d ms). - */ - waitForElementNotVisible(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; - - /** - * Waits a given time in milliseconds for an element to be present in the page before performing any other commands or assertions. - * If the element fails to be present in the specified amount of time, the test fails. You can change this by setting abortOnFailure to false. - * You can change the polling interval by defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in - * your external globals file. - * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.waitForElementPresent('body', 1000); - * // continue if failed - * browser.waitForElementPresent('body', 1000, false); - * // with callback - * browser.waitForElementPresent('body', 1000, function() { - * // do something while we're here - * }); - * // custom Spanish message - * browser.waitForElementPresent('body', 1000, 'elemento %s no era presente en %d ms'); - * // many combinations possible - the message is always the last argument - * browser.waitForElementPresent('body', 1000, false, function() {}, 'elemento %s no era presente en %d ms'); - * }; - * ``` - * @param selector: The selector (CSS / Xpath) used to locate the element. - * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. - * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. - * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. - * @param callback: Optional callback function to be called when the command finishes. - * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time - * (e.g. Element %s was not in the page for %d ms). - */ - waitForElementPresent(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; - - /** - * Waits a given time in milliseconds for an element to be visible in the page before performing any other commands or assertions. - * If the element fails to be present and visible in the specified amount of time, the test fails. You can change this by setting abortOnFailure to false. - * You can change the polling interval by defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json - * or in your external globals file. - * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). - * - * Usage: - * ``` - * this.demoTest = function (browser) { - * browser.waitForElementVisible('body', 1000); - * // continue if failed - * browser.waitForElementVisible('body', 1000, false); - * // with callback - * browser.waitForElementVisible('body', 1000, function() { - * // do something while we're here - * }); - * // custom Spanish message - * browser.waitForElementVisible('body', 1000, 'elemento %s no era visible en %d ms'); - * // many combinations possible - the message is always the last argument - * browser.waitForElementVisible('body', 1000, false, function() {}, 'elemento %s no era visible en %d ms'); - * }; - * ``` - * @param selector: The selector (CSS / Xpath) used to locate the element. - * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. - * @param abortOnFailure: By the default if the element is not found the test will fail. - * Set this to false if you wish for the test to continue even if the assertion fails. - * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. - * @param callback: Optional callback function to be called when the command finishes. - * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time (e.g. Element %s was not in the page for %d ms). - */ - waitForElementVisible(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; - /** * Accepts the currently displayed alert dialog. Usually, this is equivalent to clicking on the 'OK' button in the dialog. * @param callback: Optional callback function to be called when the command finishes. @@ -2215,3 +1847,411 @@ export interface Nightwatch { api: NightwatchAPI; client: NightwatchClient; } + +export interface EnhancedElementInstance { + name: string; + locateStrategy: string; + parent: EnhancedPageObject | EnhancedSectionInstance; + selector: string; +} + +interface EnhancedPropObj { + props: {[key: string]: any}; +} + +interface EnhancedPropFunc { + props: () => any; +} + +type props = EnhancedPropFunc | EnhancedPropObj; + +interface urlString { + url: string; +} + +interface urlFunc { + url: () => any; +} + +type url = urlString | urlFunc; + +export interface EnhancedPageObject extends SharedFunctions { + api: NightwatchAPI; + elements: EnhancedElementInstance; + name: string; + props: props; + section: EnhancedSectionInstance; + url: url; +} + +export interface EnhancedSectionInstance extends EnhancedPageObject {} + +interface SharedFunctions { + /** + * Clear a textarea or a text input element's value. Uses elementIdValue protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.clearValue('input[type=text]'); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + */ + clearValue(selector: string, callback?: () => void): this; + + /** + * Simulates a click event on the given DOM element. Uses elementIdClick protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.click("#main ul li a.first"); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + */ + click(selector: string, callback?: () => void): this; + + /** + * Retrieve the value of an attribute for a given DOM element. Uses elementIdAttribute protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.getAttribute("#main ul li a.first", "href", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, "#home"); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param attribute: The attribute name to inspect. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The value of the attribute + */ + getAttribute(selector: string, attribute: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Retrieve the value of a css property for a given DOM element. Uses elementIdCssProperty protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.getCssProperty("#main ul li a.first", "display", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, 'inline'); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param cssProperty: The CSS property to inspect. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The value of the css property + */ + getCssProperty(selector: string, cssProperty: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Determine an element's size in pixels. Uses elementIdSize protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.getElementSize("#main ul li a.first", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value.width, 500); + * this.assert.equal(result.value.height, 20); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The width and height of the element in pixels + */ + getElementSize(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Determine an element's location on the page. The point (0, 0) refers to the upper-left corner of the page. + * The element's coordinates are returned as a JSON object with x and y properties. Uses elementIdLocation protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.getLocation("#main ul li a.first", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value.x, 200); + * this.assert.equal(result.value.y, 200); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The X and Y coordinates for the element on the page + */ + getLocation(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Determine an element's location on the screen once it has been scrolled into view. Uses elementIdLocationInView protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.getLocationInView("#main ul li a.first", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value.x, 200); + * this.assert.equal(result.value.y, 200); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The X and Y coordinates for the element on the page. + */ + getLocationInView(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Query for an element's tag name. Uses elementIdName protocol command. + * + * Usage: + * ``` + * this.demoTest = function (client) { + * client.getTagName("#main ul li .first", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, "a"); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The element's tag name, as a lowercase string. + */ + getTagName(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Returns the visible text for the element. Uses elementIdText protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.getText("#main ul li a.first", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, "nightwatchjs.org"); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The element's visible text. + */ + getText(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Returns a form element current value. Uses elementIdValue protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.getValue("form.login input[type=text]", function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, "enter username"); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + * @returns The element's value. + */ + getValue(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Determine if an element is currently displayed. Uses elementIdDisplayed protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.isVisible('#main', function(result) { + * this.assert.equal(typeof result, "object"); + * this.assert.equal(result.status, 0); + * this.assert.equal(result.value, true); + * }); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + */ + isVisible(selector: string, callback?: (this: NightwatchAPI, result: NightwatchCallbackResult) => void): this; + + /** + * Move the mouse by an offset of the specified element. Uses moveTo protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.moveToElement('#main', 10, 10); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param xoffset: X offset to move to, relative to the top-left corner of the element. + * @param yoffset: Y offset to move to, relative to the top-left corner of the element. + * @param callback: Optional callback function to be called when the command finishes. + */ + moveToElement(selector: string, xoffset: number, yoffset: number, callback?: (result: NightwatchCallbackResult) => void): this; + + /** + * Sends some text to an element. Can be used to set the value of a form element or to send a sequence of key strokes to an element. Any UTF-8 character may be specified. + * An object map with available keys and their respective UTF-8 characters, as defined on W3C WebDriver draft spec (http://www.w3.org/TR/webdriver/#character-types), + * is loaded onto the main Nightwatch instance as client.Keys. + * + * Usage: + * ``` + * // send some simple text to an input + * this.demoTest = function (browser) { + * browser.setValue('input[type=text]', 'nightwatch'); + * }; + * + * // + * // send some text to an input and hit enter. + * this.demoTest = function (browser) { + * browser.setValue('input[type=text]', ['nightwatch', browser.Keys.ENTER]); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param inputValue: The text to send to the element or key strokes. + * @param callback: Optional callback function to be called when the command finishes. + */ + setValue(selector: string, inputValue: string, callback?: () => void): this; + + /** + * Submit a FORM element. The submit command may also be applied to any element that is a descendant of a FORM element. Uses submit protocol command. + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.submitForm('form.login'); + * }; + * ``` + * @param selector: The CSS/Xpath selector used to locate the element. + * @param callback: Optional callback function to be called when the command finishes. + */ + submitForm(selector: string, callback?: () => void): this; + + /** + * Opposite of waitForElementPresent. Waits a given time in milliseconds for an element to be not present (i.e. removed) in the page before performing any other commands + * or assertions. If the element is still present after the specified amount of time, the test fails. You can change the polling interval by defining + * a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in your external globals file. + * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.waitForElementNotPresent('#dialog', 1000); + * }; + * ``` + * @param selector: The selector (CSS / Xpath) used to locate the element. + * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. + * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. + * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. + * @param callback: Optional callback function to be called when the command finishes. + * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time + * (e.g. Element %s was not in the page for %d ms). + */ + waitForElementNotPresent(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; + + /** + * Opposite of waitForElementVisible. Waits a given time in milliseconds for an element to be not visible (i.e. hidden but existing) in the page before performing + * any other commands or assertions. If the element fails to be hidden in the specified amount of time, the test fails. You can change the polling interval by + * defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in your external globals file. + * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.waitForElementNotVisible('#dialog', 1000); + * }; + * ``` + * @param selector: The selector (CSS / Xpath) used to locate the element. + * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. + * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. + * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. + * @param callback: Optional callback function to be called when the command finishes. + * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time + * (e.g. Element %s was not in the page for %d ms). + */ + waitForElementNotVisible(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; + + /** + * Waits a given time in milliseconds for an element to be present in the page before performing any other commands or assertions. + * If the element fails to be present in the specified amount of time, the test fails. You can change this by setting abortOnFailure to false. + * You can change the polling interval by defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json or in + * your external globals file. + * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.waitForElementPresent('body', 1000); + * // continue if failed + * browser.waitForElementPresent('body', 1000, false); + * // with callback + * browser.waitForElementPresent('body', 1000, function() { + * // do something while we're here + * }); + * // custom Spanish message + * browser.waitForElementPresent('body', 1000, 'elemento %s no era presente en %d ms'); + * // many combinations possible - the message is always the last argument + * browser.waitForElementPresent('body', 1000, false, function() {}, 'elemento %s no era presente en %d ms'); + * }; + * ``` + * @param selector: The selector (CSS / Xpath) used to locate the element. + * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. + * @param abortOnFailure: By the default if the element is not found the test will fail. Set this to false if you wish for the test to continue even if the assertion fails. + * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. + * @param callback: Optional callback function to be called when the command finishes. + * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time + * (e.g. Element %s was not in the page for %d ms). + */ + waitForElementPresent(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; + + /** + * Waits a given time in milliseconds for an element to be visible in the page before performing any other commands or assertions. + * If the element fails to be present and visible in the specified amount of time, the test fails. You can change this by setting abortOnFailure to false. + * You can change the polling interval by defining a waitForConditionPollInterval property (in milliseconds) in as a global property in your nightwatch.json + * or in your external globals file. + * Similarly, a default timeout can be specified as a global waitForConditionTimeout property (in milliseconds). + * + * Usage: + * ``` + * this.demoTest = function (browser) { + * browser.waitForElementVisible('body', 1000); + * // continue if failed + * browser.waitForElementVisible('body', 1000, false); + * // with callback + * browser.waitForElementVisible('body', 1000, function() { + * // do something while we're here + * }); + * // custom Spanish message + * browser.waitForElementVisible('body', 1000, 'elemento %s no era visible en %d ms'); + * // many combinations possible - the message is always the last argument + * browser.waitForElementVisible('body', 1000, false, function() {}, 'elemento %s no era visible en %d ms'); + * }; + * ``` + * @param selector: The selector (CSS / Xpath) used to locate the element. + * @param time: The number of milliseconds to wait. The runner performs repeated checks every 500 ms. + * @param abortOnFailure: By the default if the element is not found the test will fail. + * Set this to false if you wish for the test to continue even if the assertion fails. + * To set this globally you can define a property `abortOnNightwatchAssertionsFailure` in your globals. + * @param callback: Optional callback function to be called when the command finishes. + * @param message: Optional message to be shown in the output; the message supports two placeholders: %s for current selector and %d for the time (e.g. Element %s was not in the page for %d ms). + */ + waitForElementVisible(selector: string, time?: number, abortOnFailure?: boolean, callback?: () => void, message?: string): this; +} From ccd51e7e798d85e6faac4cf3f51a391ab3bc4e3a Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 11:23:20 -0500 Subject: [PATCH 005/271] Changed page return type Gave an index signature for elements and section Removed props and url - someone who understands these more can add them --- types/nightwatch/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index eb084b828e..74f59d9663 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -5,7 +5,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped export interface NightwatchCustomPageObjects { - page: {[name: string]: () => NightwatchBrowser}; + page: {[name: string]: () => EnhancedPageObject}; } export interface NightwatchDesiredCapabilities { @@ -1877,7 +1877,7 @@ type url = urlString | urlFunc; export interface EnhancedPageObject extends SharedFunctions { api: NightwatchAPI; - elements: EnhancedElementInstance; + elements: {[name: string]: EnhancedElementInstance}; name: string; props: props; section: EnhancedSectionInstance; From 4e56d789dc0a69e47c0eba7cf784b521235e83c1 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 11:26:15 -0500 Subject: [PATCH 006/271] Removed props and url --- types/nightwatch/index.d.ts | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index 74f59d9663..0bcb7f83b6 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1855,33 +1855,11 @@ export interface EnhancedElementInstance { selector: string; } -interface EnhancedPropObj { - props: {[key: string]: any}; -} - -interface EnhancedPropFunc { - props: () => any; -} - -type props = EnhancedPropFunc | EnhancedPropObj; - -interface urlString { - url: string; -} - -interface urlFunc { - url: () => any; -} - -type url = urlString | urlFunc; - export interface EnhancedPageObject extends SharedFunctions { api: NightwatchAPI; elements: {[name: string]: EnhancedElementInstance}; name: string; - props: props; - section: EnhancedSectionInstance; - url: url; + section: {[name: string]: EnhancedSectionInstance}; } export interface EnhancedSectionInstance extends EnhancedPageObject {} From 4e0b76207e0752ea959ccd3a1fbaf86c0e062526 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 11:38:07 -0500 Subject: [PATCH 007/271] Removed the section definitions --- types/nightwatch/index.d.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index 0bcb7f83b6..df47fadbd0 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1851,7 +1851,7 @@ export interface Nightwatch { export interface EnhancedElementInstance { name: string; locateStrategy: string; - parent: EnhancedPageObject | EnhancedSectionInstance; + parent: EnhancedPageObject; selector: string; } @@ -1859,11 +1859,8 @@ export interface EnhancedPageObject extends SharedFunctions { api: NightwatchAPI; elements: {[name: string]: EnhancedElementInstance}; name: string; - section: {[name: string]: EnhancedSectionInstance}; } -export interface EnhancedSectionInstance extends EnhancedPageObject {} - interface SharedFunctions { /** * Clear a textarea or a text input element's value. Uses elementIdValue protocol command. From d6b4b59d4928d59e03e841797dad6cb5a22000a9 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 11:46:43 -0500 Subject: [PATCH 008/271] Export everything --- types/nightwatch/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index df47fadbd0..cbe75a9d94 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1861,7 +1861,7 @@ export interface EnhancedPageObject extends SharedFunctions { name: string; } -interface SharedFunctions { +export interface SharedFunctions { /** * Clear a textarea or a text input element's value. Uses elementIdValue protocol command. * From 9418b72625b934f07be3cd9f1682a5ef350ae7c8 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 13:58:49 -0500 Subject: [PATCH 009/271] Bumped major version Added myself as a maintainer Added documentation --- types/nightwatch/index.d.ts | 51 ++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index cbe75a9d94..1b084e4d66 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1,7 +1,8 @@ -// Type definitions for nightwatch 0.9 +// Type definitions for nightwatch 1.0 // Project: http://nightwatchjs.org/api // Definitions by: Rahul Kavalapara // Connor Schlesiger +// Clayton Astrom // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped export interface NightwatchCustomPageObjects { @@ -1848,16 +1849,64 @@ export interface Nightwatch { client: NightwatchClient; } +/** + * [Enhanced Element Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-element-instances) + * + * Element instances encapsulate the definition used to handle element selectors. + * Generally you won't need to access them directly, + * instead referring to them using their `@`-prefixed names for selector arguments, + * but they are available through a page object or section's elements property. + */ export interface EnhancedElementInstance { + + /** + * The name of the element as defined by its key in the parent section or the page object's `elements` definition. + * This is the same name used with the `@` prefix in selector arguments for page object commands that refer to the element. + */ name: string; + + /** + * The locate strategy to be used with `selector` when finding the element within the DOM. + */ locateStrategy: string; + + /** + * A reference to the parent object instance. + * This is the parent section or the page object that contained the definition for this object. + */ parent: EnhancedPageObject; + + /** + * The selector string used to find the element in the DOM. + */ selector: string; } +/** + * [Enhanced Page Object Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-page-object-instances) + * + * Page object module definitions are used to define page object instances when their respective factory functions within the page reference of the standard command API is called. + * ``` + * var myPageObject = browser.page.MyPage(); // defined in MyPage.js module + * ``` + * Every time a factory function like MyPage above is called, a new instance of the page object is instantiated. + */ export interface EnhancedPageObject extends SharedFunctions { + /** + * A reference providing access to the full Nightwatch command API, + * usually known as "client" or "browser" in test cases. + * This is used to access those commands that are not part of the subset of commands within the page object API. + */ api: NightwatchAPI; + + /** + * A map of Element objects (see [Enhanced Element Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-element-instances)) used by element selectors. + */ elements: {[name: string]: EnhancedElementInstance}; + + /** + * The name of the page object as defined by its module name (not including the extension). This is the same name used to access the `page` object factory from the page reference in the command API. + */ name: string; } From 373e1d0fc922f23e6b1d2cee74777a7df121752a Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 14:03:20 -0500 Subject: [PATCH 010/271] Fix lint --- types/nightwatch/index.d.ts | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index 1b084e4d66..dc334d11b8 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1850,17 +1850,15 @@ export interface Nightwatch { } /** - * [Enhanced Element Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-element-instances) - * - * Element instances encapsulate the definition used to handle element selectors. - * Generally you won't need to access them directly, - * instead referring to them using their `@`-prefixed names for selector arguments, + * #### [Enhanced Element Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-element-instances) + * Element instances encapsulate the definition used to handle element selectors. + * Generally you won't need to access them directly, + * instead referring to them using their `@`-prefixed names for selector arguments, * but they are available through a page object or section's elements property. */ export interface EnhancedElementInstance { - /** - * The name of the element as defined by its key in the parent section or the page object's `elements` definition. + * The name of the element as defined by its key in the parent section or the page object's `elements` definition. * This is the same name used with the `@` prefix in selector arguments for page object commands that refer to the element. */ name: string; @@ -1871,7 +1869,7 @@ export interface EnhancedElementInstance { locateStrategy: string; /** - * A reference to the parent object instance. + * A reference to the parent object instance. * This is the parent section or the page object that contained the definition for this object. */ parent: EnhancedPageObject; From c45413676b3198fd74f24d01370716398aca4b5e Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 14:04:38 -0500 Subject: [PATCH 011/271] Fix lint --- types/nightwatch/index.d.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index dc334d11b8..c96570691f 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1881,8 +1881,7 @@ export interface EnhancedElementInstance { } /** - * [Enhanced Page Object Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-page-object-instances) - * + * #### [Enhanced Page Object Instances](https://github.com/nightwatchjs/nightwatch/wiki/Page-Object-API#enhanced-page-object-instances) * Page object module definitions are used to define page object instances when their respective factory functions within the page reference of the standard command API is called. * ``` * var myPageObject = browser.page.MyPage(); // defined in MyPage.js module @@ -1891,8 +1890,8 @@ export interface EnhancedElementInstance { */ export interface EnhancedPageObject extends SharedFunctions { /** - * A reference providing access to the full Nightwatch command API, - * usually known as "client" or "browser" in test cases. + * A reference providing access to the full Nightwatch command API, + * usually known as "client" or "browser" in test cases. * This is used to access those commands that are not part of the subset of commands within the page object API. */ api: NightwatchAPI; @@ -1903,7 +1902,8 @@ export interface EnhancedPageObject extends SharedFunctions { elements: {[name: string]: EnhancedElementInstance}; /** - * The name of the page object as defined by its module name (not including the extension). This is the same name used to access the `page` object factory from the page reference in the command API. + * The name of the page object as defined by its module name (not including the extension). + * This is the same name used to access the `page` object factory from the page reference in the command API. */ name: string; } From 732040440df7b3b35244b09e24c893a9151dfd0e Mon Sep 17 00:00:00 2001 From: Alec Hill Date: Mon, 29 Oct 2018 12:25:51 +0000 Subject: [PATCH 012/271] Injected navigation props were incorrectly typed to provide only non-leaf route state props. Added tests for both kinds of injected route state. --- types/react-navigation/index.d.ts | 3 +- .../react-navigation-tests.tsx | 41 ++++++++++++++++--- 2 files changed, 37 insertions(+), 7 deletions(-) diff --git a/types/react-navigation/index.d.ts b/types/react-navigation/index.d.ts index 1bdf43bc35..4be9671d66 100644 --- a/types/react-navigation/index.d.ts +++ b/types/react-navigation/index.d.ts @@ -25,6 +25,7 @@ // Denis Frezzato // Mickael Wegerich // Max Davidson +// Alec Hill // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -1240,7 +1241,7 @@ export type Omit = Pick>; export type InferProps> = T extends React.ComponentType ? P : never; export interface NavigationInjectedProps

{ - navigation: NavigationScreenProp; + navigation: NavigationScreenProp, P>; } // If the wrapped component is a class, we can get a ref to it diff --git a/types/react-navigation/react-navigation-tests.tsx b/types/react-navigation/react-navigation-tests.tsx index 47dd7baa0e..d2ef1d522c 100644 --- a/types/react-navigation/react-navigation-tests.tsx +++ b/types/react-navigation/react-navigation-tests.tsx @@ -17,12 +17,14 @@ import { NavigationNavigateAction, NavigationProp, NavigationResetAction, + NavigationRoute, NavigationRouteConfigMap, NavigationScreenProp, NavigationScreenProps, NavigationSetParamsAction, NavigationStackAction, NavigationStackScreenOptions, + NavigationStateRoute, NavigationTabScreenOptions, NavigationTransitionProps, StackViewTransitionConfigs, @@ -70,10 +72,22 @@ interface StartScreenNavigationParams { */ class StartScreen extends React.Component> { render() { - // Implicit type checks. + // Injected type checks + const props: NavigationInjectedProps = this.props; + // route state... + const navigationState: NavigationRoute = this.props.navigation.state; + const index: number = navigationState.index; + const key: string = navigationState.key; + const routeName: string = navigationState.routeName; + const path: string | undefined = navigationState.path; + let routes: NavigationRoute[]; + if (isNavigationStateRoute(navigationState)) { + routes = navigationState.routes; + } + // params... const navigationStateParams: StartScreenNavigationParams | undefined = this.props.navigation.state.params; - const id = this.props.navigation.state.params && this.props.navigation.state.params.id; - const s = this.props.navigation.state.params && this.props.navigation.state.params.s; + const id: number | undefined = this.props.navigation.state.params && this.props.navigation.state.params.id; + const s: string | undefined = this.props.navigation.state.params && this.props.navigation.state.params.s; return ( @@ -107,17 +121,32 @@ interface NextScreenNavigationParams { class NextScreen extends React.Component> { render() { - // Implicit type checks. - const navigationStateParams: NextScreenNavigationParams | undefined = this.props.navigation.state.params; + // Injected type checks + const props: NavigationInjectedProps = this.props; + // route state... + const navigationState: NavigationRoute = this.props.navigation.state; + const index: number = navigationState.index; + const key: string = navigationState.key; + const routeName: string = navigationState.routeName; + const path: string | undefined = navigationState.path; + let routes: NavigationRoute[]; + if (isNavigationStateRoute(navigationState)) { + routes = navigationState.routes; + } + // params... + const navigationStateParams: NextScreenNavigationParams | undefined = navigationState.params; const id = this.props.navigation.state.params && this.props.navigation.state.params.id; const name = this.props.navigation.getParam('name', 'Peter'); - return ( ); } } +function isNavigationStateRoute

(route: NavigationRoute

): route is NavigationStateRoute

{ + return !!(route as NavigationStateRoute

).routes; +} + const navigationOptions = { headerBackTitle: null, }; From 6acfee7450ecb3a69e9c9827d337717562363f1a Mon Sep 17 00:00:00 2001 From: Alec Hill Date: Mon, 29 Oct 2018 15:47:20 +0000 Subject: [PATCH 013/271] Removed Slessi from authors on request --- types/react-navigation/index.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/react-navigation/index.d.ts b/types/react-navigation/index.d.ts index 4be9671d66..3562072601 100644 --- a/types/react-navigation/index.d.ts +++ b/types/react-navigation/index.d.ts @@ -14,7 +14,6 @@ // Steven Miller // Armando Assuncao // Ciaran Liedeman -// Edward Sammut Alessi // Jérémy Magrin // Luca Campana // Ullrich Schaefer From 4711ffd07c74802822e5437aa2c16403afe95d5f Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Mon, 29 Oct 2018 10:57:11 -0500 Subject: [PATCH 014/271] Reverted version to 0.9 --- types/nightwatch/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/nightwatch/index.d.ts b/types/nightwatch/index.d.ts index c96570691f..01e1d99aa6 100644 --- a/types/nightwatch/index.d.ts +++ b/types/nightwatch/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for nightwatch 1.0 +// Type definitions for nightwatch 0.9 // Project: http://nightwatchjs.org/api // Definitions by: Rahul Kavalapara // Connor Schlesiger From d67d2fbad20823a264384537f09af60aa2f9e1e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Wed, 31 Oct 2018 15:22:57 +0100 Subject: [PATCH 015/271] intl-tel-input: moved old version to subfolder in preparation for v14 --- types/intl-tel-input/v13/index.d.ts | 260 ++++++++++++++++++ .../v13/intl-tel-input-tests.ts | 70 +++++ types/intl-tel-input/v13/tsconfig.json | 27 ++ types/intl-tel-input/v13/tslint.json | 80 ++++++ 4 files changed, 437 insertions(+) create mode 100644 types/intl-tel-input/v13/index.d.ts create mode 100644 types/intl-tel-input/v13/intl-tel-input-tests.ts create mode 100644 types/intl-tel-input/v13/tsconfig.json create mode 100644 types/intl-tel-input/v13/tslint.json diff --git a/types/intl-tel-input/v13/index.d.ts b/types/intl-tel-input/v13/index.d.ts new file mode 100644 index 0000000000..34493a8b75 --- /dev/null +++ b/types/intl-tel-input/v13/index.d.ts @@ -0,0 +1,260 @@ +// Type definitions for intl-tel-input +// Project: https://github.com/jackocnr/intl-tel-input +// Definitions by: Fidan Hakaj , Leonard Thieu +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +/// + +declare namespace IntlTelInput { + + interface Plugin { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): CountryData[]; + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; + + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + (method: 'destroy'): void; + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + (method: 'getExtension'): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + */ + (method: 'getNumber'): string; + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + (method: 'getNumberType'): intlTelInputUtils.numberType; + /** + * Get the country data for the currently selected flag. + */ + (method: 'getSelectedCountryData'): IntlTelInput.CountryData; + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.validationError + */ + (method: 'getValidationError'): intlTelInputUtils.validationError; + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + (method: 'isValidNumber'): boolean; + (method: string): void; + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + (method: 'setCountry', countryCode: string): void; + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + (method: 'setNumber', aNumber: string): void; + (method: string, value: string): void; + + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + (method: 'getNumber', numberFormat: intlTelInputUtils.numberFormat): string; + (method: string, numberFormat: intlTelInputUtils.numberFormat): string; + + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (options?: IntlTelInput.Options): JQueryDeferred; + } + + interface Options { + /** + * Whether or not to allow the dropdown. If disabled, there is no dropdown + * arrow, and the selected flag is not clickable. Also we display the + * selected flag on the right instead because it is just a marker of state. + */ + allowDropdown?: boolean; + /** + * If there is just a dial code in the input: remove it on blur or submit, + * and re-add it on focus. This is to prevent just a dial code getting + * submitted with the form. Requires nationalMode to be set to false. + */ + autoHideDialCode?: boolean; + /** + * Set the input's placeholder to an example number for the selected country. + * You can specify the number type using the numberType option. + * If there is already a placeholder attribute set on the input then that + * will take precedence. Requires the utilsScript option. + */ + autoPlaceholder?: boolean; + /** + * Change the placeholder generated by autoPlaceholder. Must return a string. + */ + customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; + /** + * Specify the container for the country dropdown (use a jQuery selector + * e.g. "body"). This is useful when the input is within a scrolling element, + * or an element with overflow: hidden. Wherever you put the dropdown it + * will automatically close on the window scroll event to prevent positioning + * issues. If you want it to close when a different element is scrolled + * (such as the input's parent), simply listen for the that scroll event, + * and trigger $(window).scroll() e.g. + */ + dropdownContainer?: string; + /** + * Don't display the countries you specify. + */ + excludeCountries?: Array; + /** + * Format the input value during initialisation. + */ + formatOnInit?: boolean; + /** + * When setting initialCountry to "auto", you must use this option to + * specify a custom function that looks up the user's location. Also note + * that when instantiating the plugin, we now return a deferred object, so + * you can use .done(callback) to know when initialisation requests like + * this have completed. + * Note that the callback must still be called in the event of an error. + */ + geoIpLookup?: (callback: (countryCode: string) => void) => void; + /** + * Set the initial country selection by specifying it's country code. + * You can also set it to "auto", which will lookup the user's country based + * on their IP address (requires the geoIpLookup option). + * Note that the "auto" option will not update the country selection if the + * input already contains a number. If you leave initialCountry blank, + * it will default to the first country in the list. + */ + initialCountry?: string; + /** + * Allow users to enter national numbers (and not have to think about + * international dial codes). Formatting, validation and placeholders still + * work. Then you can use getNumber to extract a full international number. + * This option now defaults to true, and it is recommended that you leave it + * that way as it provides a better experience for the user. + */ + nationalMode?: boolean; + /** + * Display only the countries you specify. + */ + onlyCountries?: Array; + /** + * Specify one of the keys from the global enum intlTelInputUtils.numberType + * e.g. "FIXED_LINE" to set the number type to use for the placeholder. + */ + placeholderNumberType?: + | "FIXED_LINE_OR_MOBILE" + | "FIXED_LINE" + | "MOBILE" + | "PAGER" + | "PERSONAL_NUMBER" + | "PREMIUM_RATE" + | "SHARED_COST" + | "TOLL_FREE" + | "UAN" + | "UNKNOWN" + | "VOICEMAIL" + | "VOIP"; + /** + * Specify the countries to appear at the top of the list. + */ + preferredCountries?: Array; + /** + * Display the country dial code next to the selected flag so it's not part + * of the typed number. Note that this will disable nationalMode because + * technically we are dealing with international numbers, but with the + * dial code separated. + */ + separateDialCode?: boolean; + /** + * Enable formatting/validation etc. by specifying the path to the included + * utils.js script, which is fetched only when the page has finished loading + * (on window.load) to prevent blocking. When instantiating the plugin, + * we return a deferred object, so you can use .done(callback) to know when + * initialisation requests like this have finished. Note that if you're + * lazy loading the plugin script itself (intlTelInput.js) this will not + * work and you will need to use the loadUtils method instead. + */ + utilsScript?: string; + } + + interface CountryData { + name: string; + iso2: string; + dialCode: string; + } +} + +declare namespace intlTelInputUtils { + + const enum numberFormat { + E164 = 0, + INTERNATIONAL = 1, + NATIONAL = 2, + RFC3966 = 3 + } + + const enum numberType { + FIXED_LINE = 0, + MOBILE = 1, + FIXED_LINE_OR_MOBILE = 2, + TOLL_FREE = 3, + PREMIUM_RATE = 4, + SHARED_COST = 5, + VOIP = 6, + PERSONAL_NUMBER = 7, + PAGER = 8, + UAN = 9, + VOICEMAIL = 10, + UNKNOWN = -1 + } + + const enum validationError { + IS_POSSIBLE = 0, + INVALID_COUNTRY_CODE = 1, + TOO_SHORT = 2, + TOO_LONG = 3, + NOT_A_NUMBER = 4 + } +} + +interface JQuery { + intlTelInput: IntlTelInput.Plugin; +} diff --git a/types/intl-tel-input/v13/intl-tel-input-tests.ts b/types/intl-tel-input/v13/intl-tel-input-tests.ts new file mode 100644 index 0000000000..e91a5deef1 --- /dev/null +++ b/types/intl-tel-input/v13/intl-tel-input-tests.ts @@ -0,0 +1,70 @@ +$('#phone').intlTelInput(); + +$('#phone').intlTelInput({ + customPlaceholder: function(selectedCountryPlaceholder, selectedCountryData) { + return 'e.g. ' + selectedCountryPlaceholder; + } +}); + +$('#phone').intlTelInput({ + placeholderNumberType: "MOBILE", +}); + +$('#phone').intlTelInput({ + geoIpLookup: function(callback) { + $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { + let countryCode = (resp && resp.country) ? resp.country : ''; + callback(countryCode); + }); + } +}); + +$('#phone').intlTelInput('destroy'); + +let extension = $('#phone').intlTelInput('getExtension'); + +let intlNumber = $('#phone').intlTelInput('getNumber'); +let ntlNumber = $('#phone').intlTelInput('getNumber', intlTelInputUtils.numberFormat.NATIONAL); + +let numberType = $('#phone').intlTelInput('getNumberType'); +if (numberType === intlTelInputUtils.numberType.MOBILE) {} + +let selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); + +let error = $('#phone').intlTelInput('getValidationError'); +if (error === intlTelInputUtils.validationError.TOO_SHORT) {} + +let isValid = $('#phone').intlTelInput('isValidNumber'); + +$('#phone').intlTelInput('setCountry', 'gb'); + +$('#phone').intlTelInput('setNumber', '+447733123456'); + +let countryData = $.fn.intlTelInput.getCountryData(); + +$.fn.intlTelInput.loadUtils('build/js/utils.js'); + +$('#phone').intlTelInput({ + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + initialCountry: 'auto', + geoIpLookup: function(callback) { + $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { + let countryCode = (resp && resp.country) ? resp.country : ''; + callback(countryCode); + }); + }, + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + nationalMode: true, + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + onlyCountries: ['al'], + utilsScript: '../../build/js/utils.js' +}); diff --git a/types/intl-tel-input/v13/tsconfig.json b/types/intl-tel-input/v13/tsconfig.json new file mode 100644 index 0000000000..b7e1b435b1 --- /dev/null +++ b/types/intl-tel-input/v13/tsconfig.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "strictFunctionTypes": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "paths": { + "intl-tel-input": [ "intl-tel-input/v13" ] + }, + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "intl-tel-input-tests.ts" + ] +} \ No newline at end of file diff --git a/types/intl-tel-input/v13/tslint.json b/types/intl-tel-input/v13/tslint.json new file mode 100644 index 0000000000..b6afb8acee --- /dev/null +++ b/types/intl-tel-input/v13/tslint.json @@ -0,0 +1,80 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "adjacent-overload-signatures": false, + "array-type": false, + "arrow-return-shorthand": false, + "ban-types": false, + "callable-types": false, + "comment-format": false, + "dt-header": false, + "eofline": false, + "export-just-namespace": false, + "import-spacing": false, + "interface-name": false, + "interface-over-type-literal": false, + "jsdoc-format": false, + "max-line-length": false, + "member-access": false, + "new-parens": false, + "no-any-union": false, + "no-boolean-literal-compare": false, + "no-conditional-assignment": false, + "no-consecutive-blank-lines": false, + "no-const-enum": false, + "no-construct": false, + "no-declare-current-package": false, + "no-duplicate-imports": false, + "no-duplicate-variable": false, + "no-empty-interface": false, + "no-for-in-array": false, + "no-inferrable-types": false, + "no-internal-module": false, + "no-irregular-whitespace": false, + "no-mergeable-namespace": false, + "no-misused-new": false, + "no-namespace": false, + "no-object-literal-type-assertion": false, + "no-padding": false, + "no-redundant-jsdoc": false, + "no-redundant-jsdoc-2": false, + "no-redundant-undefined": false, + "no-reference-import": false, + "no-relative-import-in-test": false, + "no-self-import": false, + "no-single-declare-module": false, + "no-string-throw": false, + "no-unnecessary-callback-wrapper": false, + "no-unnecessary-class": false, + "no-unnecessary-generics": false, + "no-unnecessary-qualifier": false, + "no-unnecessary-type-assertion": false, + "no-useless-files": false, + "no-var-keyword": false, + "no-var-requires": false, + "no-void-expression": false, + "no-trailing-whitespace": false, + "object-literal-key-quotes": false, + "object-literal-shorthand": false, + "one-line": false, + "one-variable-per-declaration": false, + "only-arrow-functions": false, + "prefer-conditional-expression": false, + "prefer-const": false, + "prefer-declare-function": false, + "prefer-for-of": false, + "prefer-method-signature": false, + "prefer-template": false, + "radix": false, + "semicolon": false, + "space-before-function-paren": false, + "space-within-parens": false, + "strict-export-declare-modifiers": false, + "trim-file": false, + "triple-equals": false, + "typedef-whitespace": false, + "unified-signatures": false, + "void-return": false, + "whitespace": false + } +} From 244f5c736bc818e276bb49240de4eb2e4b183236 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Wed, 31 Oct 2018 16:40:06 +0100 Subject: [PATCH 016/271] v14 type definition (tests still needed for new options) --- types/intl-tel-input/index.d.ts | 522 ++++++++++--------- types/intl-tel-input/intl-tel-input-tests.ts | 63 ++- types/intl-tel-input/tslint.json | 79 +-- 3 files changed, 308 insertions(+), 356 deletions(-) diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index 34493a8b75..b0752632c3 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -1,260 +1,290 @@ -// Type definitions for intl-tel-input +// Type definitions for intl-tel-input 14.0 // Project: https://github.com/jackocnr/intl-tel-input -// Definitions by: Fidan Hakaj , Leonard Thieu +// Definitions by: Fidan Hakaj , Leonard Thieu , Márton Molnár // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 -/// +export interface IntlTelInputStatic { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): CountryData[]; -declare namespace IntlTelInput { + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; - interface Plugin { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): CountryData[]; - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; - - /** - * Remove the plugin from the input, and unbind any event listeners. - */ - (method: 'destroy'): void; - /** - * Get the extension from the current number. - * Requires the utilsScript option. - * e.g. if the input value was "(702) 555-5555 ext. 1234", this would - * return "1234". - */ - (method: 'getExtension'): string; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - */ - (method: 'getNumber'): string; - /** - * Get the type (fixed-line/mobile/toll-free etc) of the current number. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.numberType. - * Note that in the US there's no way to differentiate between fixed-line and - * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. - */ - (method: 'getNumberType'): intlTelInputUtils.numberType; - /** - * Get the country data for the currently selected flag. - */ - (method: 'getSelectedCountryData'): IntlTelInput.CountryData; - /** - * Get more information about a validation error. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.validationError - */ - (method: 'getValidationError'): intlTelInputUtils.validationError; - /** - * Validate the current number. Expects an internationally formatted number - * (unless nationalMode is enabled). If validation fails, you can use - * getValidationError to get more information. - * Requires the utilsScript option. - * Also see getNumberType if you want to make sure the user enters a certain - * type of number e.g. a mobile number. - */ - (method: 'isValidNumber'): boolean; - (method: string): void; - /** - * Change the country selection (e.g. when the user is entering their address). - * @param countryCode country code of the country to be set. - */ - (method: 'setCountry', countryCode: string): void; - /** - * Insert a number, and update the selected flag accordingly. - * Note that by default, if nationalMode is enabled it will try to use - * national formatting. - * @param aNumber number to be set. - */ - (method: 'setNumber', aNumber: string): void; - (method: string, value: string): void; - - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - * @param numberFormat the format in which the number will be returned. - */ - (method: 'getNumber', numberFormat: intlTelInputUtils.numberFormat): string; - (method: string, numberFormat: intlTelInputUtils.numberFormat): string; - - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (options?: IntlTelInput.Options): JQueryDeferred; - } - - interface Options { - /** - * Whether or not to allow the dropdown. If disabled, there is no dropdown - * arrow, and the selected flag is not clickable. Also we display the - * selected flag on the right instead because it is just a marker of state. - */ - allowDropdown?: boolean; - /** - * If there is just a dial code in the input: remove it on blur or submit, - * and re-add it on focus. This is to prevent just a dial code getting - * submitted with the form. Requires nationalMode to be set to false. - */ - autoHideDialCode?: boolean; - /** - * Set the input's placeholder to an example number for the selected country. - * You can specify the number type using the numberType option. - * If there is already a placeholder attribute set on the input then that - * will take precedence. Requires the utilsScript option. - */ - autoPlaceholder?: boolean; - /** - * Change the placeholder generated by autoPlaceholder. Must return a string. - */ - customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; - /** - * Specify the container for the country dropdown (use a jQuery selector - * e.g. "body"). This is useful when the input is within a scrolling element, - * or an element with overflow: hidden. Wherever you put the dropdown it - * will automatically close on the window scroll event to prevent positioning - * issues. If you want it to close when a different element is scrolled - * (such as the input's parent), simply listen for the that scroll event, - * and trigger $(window).scroll() e.g. - */ - dropdownContainer?: string; - /** - * Don't display the countries you specify. - */ - excludeCountries?: Array; - /** - * Format the input value during initialisation. - */ - formatOnInit?: boolean; - /** - * When setting initialCountry to "auto", you must use this option to - * specify a custom function that looks up the user's location. Also note - * that when instantiating the plugin, we now return a deferred object, so - * you can use .done(callback) to know when initialisation requests like - * this have completed. - * Note that the callback must still be called in the event of an error. - */ - geoIpLookup?: (callback: (countryCode: string) => void) => void; - /** - * Set the initial country selection by specifying it's country code. - * You can also set it to "auto", which will lookup the user's country based - * on their IP address (requires the geoIpLookup option). - * Note that the "auto" option will not update the country selection if the - * input already contains a number. If you leave initialCountry blank, - * it will default to the first country in the list. - */ - initialCountry?: string; - /** - * Allow users to enter national numbers (and not have to think about - * international dial codes). Formatting, validation and placeholders still - * work. Then you can use getNumber to extract a full international number. - * This option now defaults to true, and it is recommended that you leave it - * that way as it provides a better experience for the user. - */ - nationalMode?: boolean; - /** - * Display only the countries you specify. - */ - onlyCountries?: Array; - /** - * Specify one of the keys from the global enum intlTelInputUtils.numberType - * e.g. "FIXED_LINE" to set the number type to use for the placeholder. - */ - placeholderNumberType?: - | "FIXED_LINE_OR_MOBILE" - | "FIXED_LINE" - | "MOBILE" - | "PAGER" - | "PERSONAL_NUMBER" - | "PREMIUM_RATE" - | "SHARED_COST" - | "TOLL_FREE" - | "UAN" - | "UNKNOWN" - | "VOICEMAIL" - | "VOIP"; - /** - * Specify the countries to appear at the top of the list. - */ - preferredCountries?: Array; - /** - * Display the country dial code next to the selected flag so it's not part - * of the typed number. Note that this will disable nationalMode because - * technically we are dealing with international numbers, but with the - * dial code separated. - */ - separateDialCode?: boolean; - /** - * Enable formatting/validation etc. by specifying the path to the included - * utils.js script, which is fetched only when the page has finished loading - * (on window.load) to prevent blocking. When instantiating the plugin, - * we return a deferred object, so you can use .done(callback) to know when - * initialisation requests like this have finished. Note that if you're - * lazy loading the plugin script itself (intlTelInput.js) this will not - * work and you will need to use the loadUtils method instead. - */ - utilsScript?: string; - } - - interface CountryData { - name: string; - iso2: string; - dialCode: string; - } + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (node: Element, options?: IntlTelInputOptions): IntlTelInput; } -declare namespace intlTelInputUtils { +export interface IntlTelInput { + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + destroy(): void; - const enum numberFormat { - E164 = 0, - INTERNATIONAL = 1, - NATIONAL = 2, - RFC3966 = 3 - } + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + getExtension(): string; - const enum numberType { - FIXED_LINE = 0, - MOBILE = 1, - FIXED_LINE_OR_MOBILE = 2, - TOLL_FREE = 3, - PREMIUM_RATE = 4, - SHARED_COST = 5, - VOIP = 6, - PERSONAL_NUMBER = 7, - PAGER = 8, - UAN = 9, - VOICEMAIL = 10, - UNKNOWN = -1 - } + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + getNumber(numberFormat?: NumberFormat): string; - const enum validationError { - IS_POSSIBLE = 0, - INVALID_COUNTRY_CODE = 1, - TOO_SHORT = 2, - TOO_LONG = 3, - NOT_A_NUMBER = 4 - } + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + getNumberType(): NumberType; + + /** + * Get the country data for the currently selected flag. + */ + getSelectedCountryData(): CountryData; + + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.validationError + */ + getValidationError(): ValidationError; + + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + isValidNumber(): boolean; + + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + setCountry(countryCode: string): void; + + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + setNumber(aNumber: string): void; + + /** + * Set the type of the placeholder number + * @param type Placeholder number type to be set + */ + setPlaceholderNumberType(type: NumberType): void; } -interface JQuery { - intlTelInput: IntlTelInput.Plugin; +export interface IntlTelInputOptions { + /** + * Whether or not to allow the dropdown. If disabled, there is no dropdown + * arrow, and the selected flag is not clickable. Also we display the + * selected flag on the right instead because it is just a marker of state. + * Default = true + */ + allowDropdown?: boolean; + + /** + * If there is just a dial code in the input: remove it on blur or submit, + * and re-add it on focus. This is to prevent just a dial code getting + * submitted with the form. Requires nationalMode to be set to false. + * Default = true + */ + autoHideDialCode?: boolean; + + /** + * Set the input's placeholder to an example number for the selected country, and update it if the country changes. + * You can specify the number type using the placeholderNumberType option. + * By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. + * You can also set it to "aggressive", which will replace any existing placeholder, or "off". + * Requires the utilsScript option. + * Default = "polite" + */ + autoPlaceholder?: "off" | "polite" | "aggressive"; + + /** + * Change the placeholder generated by autoPlaceholder. Must return a string. + * Default = null + */ + customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; + + /** + * Expects a node e.g. document.body. Instead of putting the country dropdown next to the input, + * append it to the specified node, and it will then be positioned absolutely next to the input using JavaScript. + * This is useful when the input is inside a container with overflow: hidden. + * Note that the absolute positioning can be broken by scrolling, so it will automatically close on the window scroll event. + * Default = null + */ + dropdownContainer?: Node; + + /** + * In the dropdown, display all countries except the ones you specify here. + * Default = null + */ + excludeCountries?: string[]; + + /** + * Format the input value (according to the nationalMode option) during initialisation, and on setNumber. + * Requires the utilsScript option. + * Default = true + */ + formatOnDisplay?: boolean; + + /** + * When setting initialCountry to "auto", you must use this option to + * specify a custom function that looks up the user's location, + * and then calls the success callback with the relevant country code. + * Also note that when instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can + * do something like iti.promise.then(callback) to know when initialisation requests like this have completed. + * Default = null + */ + geoIpLookup?: (callback: (countryCode: string) => void) => void; + + /** + * Add a hidden input with the given name (or if your input name contains square brackets then it will give the hidden input the same name, + * replacing the contents of the brackets with the given name). On submit, populate it with the full international number (using getNumber). + * This is a quick way for people using non-ajax forms to get the full international number, even when nationalMode is enabled. + * Note: requires the input to be inside a form element, as this feature works by listening for the submit event on the closest form element. + * Also note that since this uses getNumber internally, it expects a valid number, and so should only be used after validation. + * Default = "" + */ + hiddenInput?: string; + + /** + * Set the initial country selection by specifying it's country code. + * You can also set it to "auto", which will lookup the user's country based + * on their IP address (requires the geoIpLookup option). + * Note that the "auto" option will not update the country selection if the + * input already contains a number. If you leave initialCountry blank, + * it will default to the first country in the list. + */ + initialCountry?: string; + + /** + * Allows to translate the countries by its given iso code e.g.: { 'de': 'Deutschland' } + * Default = {} + */ + localizedCountries?: object; + + /** + * Allow users to enter national numbers (and not have to think about + * international dial codes). Formatting, validation and placeholders still + * work. Then you can use getNumber to extract a full international number. + * This option now defaults to true, and it is recommended that you leave it + * that way as it provides a better experience for the user. + * Default = true + */ + nationalMode?: boolean; + + /** + * In the dropdown, display only the countries you specify. + * Default = undefined + */ + onlyCountries?: string[]; + + /** + * Specify one of the keys from the global enum intlTelInputUtils.numberType + * e.g. "FIXED_LINE" to set the number type to use for the placeholder. + * Default = MOBILE + */ + placeholderNumberType?: NumberType; + + /** + * Specify the countries to appear at the top of the list. + * Default = ["us", "gb"] + */ + preferredCountries?: string[]; + + /** + * Display the country dial code next to the selected flag so it's not part + * of the typed number. Note that this will disable nationalMode because + * technically we are dealing with international numbers, but with the + * dial code separated. + * Default = false + */ + separateDialCode?: boolean; + + /** + * Enable formatting/validation etc. by specifying the URL of the included utils.js script + * (or alternatively just point it to the file on cdnjs.com). The script is fetched when the page has finished loading (on the window load event) + * to prevent blocking (the script is ~215KB). When instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can do something like + * iti.promise.then(callback) to know when initialisation requests like this have finished. + * Note that if you're lazy loading the plugin script itself (intlTelInput.js) + * this will not work and you will need to use the loadUtils method instead. + * Example: "build/js/utils.js" + * Default = "" + */ + utilsScript?: string; +} + +export interface CountryData { + name: string; + iso2: string; + dialCode: string; +} + +export enum NumberFormat { + E164 = 0, + INTERNATIONAL = 1, + NATIONAL = 2, + RFC3966 = 3 +} + +export enum NumberType { + FIXED_LINE = 0, + MOBILE = 1, + FIXED_LINE_OR_MOBILE = 2, + TOLL_FREE = 3, + PREMIUM_RATE = 4, + SHARED_COST = 5, + VOIP = 6, + PERSONAL_NUMBER = 7, + PAGER = 8, + UAN = 9, + VOICEMAIL = 10, + UNKNOWN = -1 +} + +export enum ValidationError { + IS_POSSIBLE = 0, + INVALID_COUNTRY_CODE = 1, + TOO_SHORT = 2, + TOO_LONG = 3, + NOT_A_NUMBER = 4 +} + +declare global { + interface Window { + intlTelInput: IntlTelInputStatic; + } } diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index e91a5deef1..9a84e98428 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -1,70 +1,69 @@ -$('#phone').intlTelInput(); +import IntlTelInput = require("intl-tel-input"); -$('#phone').intlTelInput({ - customPlaceholder: function(selectedCountryPlaceholder, selectedCountryData) { +const input = document.querySelector("#phone"); +window.intlTelInput(input); + +window.intlTelInput(input, { + customPlaceholder(selectedCountryPlaceholder, selectedCountryData) { return 'e.g. ' + selectedCountryPlaceholder; } }); -$('#phone').intlTelInput({ - placeholderNumberType: "MOBILE", +window.intlTelInput(input, { + placeholderNumberType: IntlTelInput.NumberType.MOBILE, }); -$('#phone').intlTelInput({ - geoIpLookup: function(callback) { - $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { - let countryCode = (resp && resp.country) ? resp.country : ''; +window.intlTelInput(input, { + geoIpLookup(callback) { + const countryCode = 'XY'; callback(countryCode); - }); } }); -$('#phone').intlTelInput('destroy'); +window.intlTelInput(input).destroy(); -let extension = $('#phone').intlTelInput('getExtension'); +const extension = window.intlTelInput(input).getExtension(); -let intlNumber = $('#phone').intlTelInput('getNumber'); -let ntlNumber = $('#phone').intlTelInput('getNumber', intlTelInputUtils.numberFormat.NATIONAL); +const intlNumber = window.intlTelInput(input).getNumber(); +const ntlNumber = window.intlTelInput(input).getNumber(IntlTelInput.NumberFormat.NATIONAL); -let numberType = $('#phone').intlTelInput('getNumberType'); -if (numberType === intlTelInputUtils.numberType.MOBILE) {} +const numberType = window.intlTelInput(input).getNumberType(); +if (numberType === IntlTelInput.NumberType.MOBILE) {} -let selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); +const selectedCountryData = window.intlTelInput(input).getSelectedCountryData(); -let error = $('#phone').intlTelInput('getValidationError'); -if (error === intlTelInputUtils.validationError.TOO_SHORT) {} +const error = window.intlTelInput(input).getValidationError(); +if (error === IntlTelInput.ValidationError.TOO_SHORT) {} -let isValid = $('#phone').intlTelInput('isValidNumber'); +const isValid = window.intlTelInput(input).isValidNumber(); -$('#phone').intlTelInput('setCountry', 'gb'); +window.intlTelInput(input).setCountry('gb'); -$('#phone').intlTelInput('setNumber', '+447733123456'); +window.intlTelInput(input).setNumber('+447733123456'); -let countryData = $.fn.intlTelInput.getCountryData(); +const countryData = window.intlTelInput.getCountryData(); -$.fn.intlTelInput.loadUtils('build/js/utils.js'); +window.intlTelInput.loadUtils('build/js/utils.js'); -$('#phone').intlTelInput({ +window.intlTelInput(input, { utilsScript: '../../build/js/utils.js' }); -$('#phone').intlTelInput({ +window.intlTelInput(input, { initialCountry: 'auto', - geoIpLookup: function(callback) { - $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { - let countryCode = (resp && resp.country) ? resp.country : ''; + geoIpLookup: (callback) => { + const countryCode = 'XY'; callback(countryCode); - }); }, utilsScript: '../../build/js/utils.js' }); -$('#phone').intlTelInput({ +window.intlTelInput(input, { nationalMode: true, utilsScript: '../../build/js/utils.js' }); -$('#phone').intlTelInput({ +window.intlTelInput(input, { onlyCountries: ['al'], utilsScript: '../../build/js/utils.js' }); diff --git a/types/intl-tel-input/tslint.json b/types/intl-tel-input/tslint.json index b6afb8acee..f93cf8562a 100644 --- a/types/intl-tel-input/tslint.json +++ b/types/intl-tel-input/tslint.json @@ -1,80 +1,3 @@ { - "extends": "dtslint/dt.json", - "rules": { - "adjacent-overload-signatures": false, - "array-type": false, - "arrow-return-shorthand": false, - "ban-types": false, - "callable-types": false, - "comment-format": false, - "dt-header": false, - "eofline": false, - "export-just-namespace": false, - "import-spacing": false, - "interface-name": false, - "interface-over-type-literal": false, - "jsdoc-format": false, - "max-line-length": false, - "member-access": false, - "new-parens": false, - "no-any-union": false, - "no-boolean-literal-compare": false, - "no-conditional-assignment": false, - "no-consecutive-blank-lines": false, - "no-const-enum": false, - "no-construct": false, - "no-declare-current-package": false, - "no-duplicate-imports": false, - "no-duplicate-variable": false, - "no-empty-interface": false, - "no-for-in-array": false, - "no-inferrable-types": false, - "no-internal-module": false, - "no-irregular-whitespace": false, - "no-mergeable-namespace": false, - "no-misused-new": false, - "no-namespace": false, - "no-object-literal-type-assertion": false, - "no-padding": false, - "no-redundant-jsdoc": false, - "no-redundant-jsdoc-2": false, - "no-redundant-undefined": false, - "no-reference-import": false, - "no-relative-import-in-test": false, - "no-self-import": false, - "no-single-declare-module": false, - "no-string-throw": false, - "no-unnecessary-callback-wrapper": false, - "no-unnecessary-class": false, - "no-unnecessary-generics": false, - "no-unnecessary-qualifier": false, - "no-unnecessary-type-assertion": false, - "no-useless-files": false, - "no-var-keyword": false, - "no-var-requires": false, - "no-void-expression": false, - "no-trailing-whitespace": false, - "object-literal-key-quotes": false, - "object-literal-shorthand": false, - "one-line": false, - "one-variable-per-declaration": false, - "only-arrow-functions": false, - "prefer-conditional-expression": false, - "prefer-const": false, - "prefer-declare-function": false, - "prefer-for-of": false, - "prefer-method-signature": false, - "prefer-template": false, - "radix": false, - "semicolon": false, - "space-before-function-paren": false, - "space-within-parens": false, - "strict-export-declare-modifiers": false, - "trim-file": false, - "triple-equals": false, - "typedef-whitespace": false, - "unified-signatures": false, - "void-return": false, - "whitespace": false - } + "extends": "dtslint/dt.json" } From ed4de5dd4c9be7f22f360b7e3e801098c41f2aa8 Mon Sep 17 00:00:00 2001 From: Simon Meusel Date: Sat, 3 Nov 2018 11:44:41 +0100 Subject: [PATCH 017/271] Remove typings for gitlab --- notNeededPackages.json | 6 ++ types/gitlab/ApiBase.d.ts | 31 ----------- types/gitlab/ApiBaseHTTP.d.ts | 12 ---- types/gitlab/ApiV3.d.ts | 5 -- types/gitlab/BaseModel.d.ts | 17 ------ types/gitlab/Models/Groups.d.ts | 27 --------- types/gitlab/Models/IssueNotes.d.ts | 6 -- types/gitlab/Models/Issues.d.ts | 12 ---- types/gitlab/Models/Labels.d.ts | 5 -- types/gitlab/Models/Notes.d.ts | 5 -- types/gitlab/Models/Pipelines.d.ts | 5 -- types/gitlab/Models/ProjectBuilds.d.ts | 13 ----- types/gitlab/Models/ProjectDeployKeys.d.ts | 7 --- types/gitlab/Models/ProjectHooks.d.ts | 16 ------ types/gitlab/Models/ProjectIssues.d.ts | 9 --- types/gitlab/Models/ProjectLabels.d.ts | 6 -- types/gitlab/Models/ProjectMembers.d.ts | 12 ---- types/gitlab/Models/ProjectMergeRequests.d.ts | 11 ---- types/gitlab/Models/ProjectMilestones.d.ts | 12 ---- types/gitlab/Models/ProjectRepository.d.ts | 39 ------------- types/gitlab/Models/ProjectServices.d.ts | 9 --- types/gitlab/Models/Projects.d.ts | 55 ------------------- types/gitlab/Models/Runners.d.ts | 11 ---- types/gitlab/Models/UserKeys.d.ts | 6 -- types/gitlab/Models/Users.d.ts | 17 ------ types/gitlab/gitlab-tests.ts | 20 ------- types/gitlab/index.d.ts | 17 ------ types/gitlab/tsconfig.json | 23 -------- types/gitlab/tslint.json | 14 ----- 29 files changed, 6 insertions(+), 422 deletions(-) delete mode 100644 types/gitlab/ApiBase.d.ts delete mode 100644 types/gitlab/ApiBaseHTTP.d.ts delete mode 100644 types/gitlab/ApiV3.d.ts delete mode 100644 types/gitlab/BaseModel.d.ts delete mode 100644 types/gitlab/Models/Groups.d.ts delete mode 100644 types/gitlab/Models/IssueNotes.d.ts delete mode 100644 types/gitlab/Models/Issues.d.ts delete mode 100644 types/gitlab/Models/Labels.d.ts delete mode 100644 types/gitlab/Models/Notes.d.ts delete mode 100644 types/gitlab/Models/Pipelines.d.ts delete mode 100644 types/gitlab/Models/ProjectBuilds.d.ts delete mode 100644 types/gitlab/Models/ProjectDeployKeys.d.ts delete mode 100644 types/gitlab/Models/ProjectHooks.d.ts delete mode 100644 types/gitlab/Models/ProjectIssues.d.ts delete mode 100644 types/gitlab/Models/ProjectLabels.d.ts delete mode 100644 types/gitlab/Models/ProjectMembers.d.ts delete mode 100644 types/gitlab/Models/ProjectMergeRequests.d.ts delete mode 100644 types/gitlab/Models/ProjectMilestones.d.ts delete mode 100644 types/gitlab/Models/ProjectRepository.d.ts delete mode 100644 types/gitlab/Models/ProjectServices.d.ts delete mode 100644 types/gitlab/Models/Projects.d.ts delete mode 100644 types/gitlab/Models/Runners.d.ts delete mode 100644 types/gitlab/Models/UserKeys.d.ts delete mode 100644 types/gitlab/Models/Users.d.ts delete mode 100644 types/gitlab/gitlab-tests.ts delete mode 100644 types/gitlab/index.d.ts delete mode 100644 types/gitlab/tsconfig.json delete mode 100644 types/gitlab/tslint.json diff --git a/notNeededPackages.json b/notNeededPackages.json index f81984b338..5417ec227a 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -624,6 +624,12 @@ "sourceRepoURL": "https://github.com/mikedeboer/node-github", "asOfVersion": "7.1.0" }, + { + "libraryName": "gitlab", + "typingsPackageName": "gitlab", + "sourceRepoURL": "https://github.com/jdalrymple/node-gitlab", + "asOfVersion": "2.0.0" + }, { "libraryName": "graphene-pk11", "typingsPackageName": "graphene-pk11", diff --git a/types/gitlab/ApiBase.d.ts b/types/gitlab/ApiBase.d.ts deleted file mode 100644 index 7187ce4352..0000000000 --- a/types/gitlab/ApiBase.d.ts +++ /dev/null @@ -1,31 +0,0 @@ -import { ApiBaseOptions } from './ApiBase'; -import { Labels } from './Models/Labels'; -import { Users } from './Models/Users'; -import { Notes } from './Models/Notes'; -import { Issues } from './Models/Issues'; -import { Projects } from './Models/Projects'; -import { Groups } from './Models/Groups'; - -export interface ApiBaseOptions { - url?: string; - token?: string; - oauth_token?: string; - base_url?: string; - auth?: any; - [key: string]: any; -} - -export class ApiBase { - constructor(options: ApiBaseOptions); - readonly client: this; - readonly groups: Groups - readonly projects: Projects - readonly issues: Issues - readonly notes: Notes - readonly users: Users - readonly labels: Labels - options: ApiBaseOptions; - - handleOptions(): void; - init(): object; -} diff --git a/types/gitlab/ApiBaseHTTP.d.ts b/types/gitlab/ApiBaseHTTP.d.ts deleted file mode 100644 index 7ed5fb0d69..0000000000 --- a/types/gitlab/ApiBaseHTTP.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { ApiBase } from './ApiBase'; - -export class ApiBaseHTTP extends ApiBase { - prepare_opts(opts: T): T; - fn_wrapper(fn: T): T; - get(path: string, fn?: Function): any; - get(path: string, query?: object, fn?: Function): any; - delete(path: string, fn?: Function): any; - post(path: string, data?: object, fn?: Function): any; - put(path: string, data?: object, fn?: Function): any; - patch(path: string, data?: object, fn?: Function): any; -} diff --git a/types/gitlab/ApiV3.d.ts b/types/gitlab/ApiV3.d.ts deleted file mode 100644 index bd3d02557b..0000000000 --- a/types/gitlab/ApiV3.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { ApiBaseHTTP } from './ApiBaseHTTP'; - -export class ApiV3 extends ApiBaseHTTP { - -} diff --git a/types/gitlab/BaseModel.d.ts b/types/gitlab/BaseModel.d.ts deleted file mode 100644 index ca6eb4e7c6..0000000000 --- a/types/gitlab/BaseModel.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -export class BaseModel { - load(model: string): object; - get(path: string, fn?: Function): any; - get(path: string, query?: object, fn?: Function): any; - delete(path: string, fn?: Function): any; - post(path: string, data?: object, fn?: Function): any; - put(path: string, data?: object, fn?: Function): any; - patch(path: string, data?: object, fn?: Function): any; -} - -export interface DefParams { - page?: number; - per_page?: number; - [key: string]: any; -} - -export type TId = number | string; diff --git a/types/gitlab/Models/Groups.d.ts b/types/gitlab/Models/Groups.d.ts deleted file mode 100644 index 1b528039f0..0000000000 --- a/types/gitlab/Models/Groups.d.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { BaseModel, DefParams } from "../BaseModel"; - -interface IAccessLevels { - GUEST: number - REPORTER: number - DEVELOPER: number - MASTER: number - OWNER: number -} - -export class Groups extends BaseModel { - readonly access_levels: IAccessLevels; - - init(): object; - all(fn?: Function): any; - all(params?: DefParams, fn?: Function): any; - show(groupId: number, fn?: Function): any; - listProjects(groupId: number, fn?: Function): any; - listMembers(groupId: number, fn?: Function): any; - addMember(groupId: number, userId: number, accessLevel: IAccessLevels[keyof IAccessLevels], fn?: Function): any; - editMember(groupId: number, userId: number, accessLevel: IAccessLevels[keyof IAccessLevels], fn?: Function): any; - removeMember(groupId: number, userId: number, fn?: Function): any; - create(params?: object, fn?: Function): any; - addProject(groupId: number, projectId: number, fn?: Function): any; - deleteGroup(groupId: number, fn?: Function): any; - search(nameOrPath: string, fn?: Function): any; -} diff --git a/types/gitlab/Models/IssueNotes.d.ts b/types/gitlab/Models/IssueNotes.d.ts deleted file mode 100644 index de1821b1df..0000000000 --- a/types/gitlab/Models/IssueNotes.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { BaseModel, TId, DefParams } from '../BaseModel'; - -export class IssueNotes extends BaseModel{ - all(projectId: TId, issueId: number, fn?: Function): any - all(projectId: TId, issueId: number, params?: DefParams, fn?: Function): any -} diff --git a/types/gitlab/Models/Issues.d.ts b/types/gitlab/Models/Issues.d.ts deleted file mode 100644 index e751b6a002..0000000000 --- a/types/gitlab/Models/Issues.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -export class Issues extends BaseModel { - all(fn?: Function): any; - all(params?: object, fn?: Function): any; - show(projectId: TId, issueId: TId, fn?: Function): any; - create(projectId: TId, params?: object, fn?: Function): any; - edit(projectId: TId, issueId: TId, params?: object, fn?: Function): any; - remove(projectId: TId, issueId: TId, fn?: Function): any; - subscribe(projectId: TId, issueId: TId, params?: object, fn?: Function): any; - unsubscribe(projectId: TId, issueId: TId, fn?: Function): any; -} diff --git a/types/gitlab/Models/Labels.d.ts b/types/gitlab/Models/Labels.d.ts deleted file mode 100644 index 63f1110b4d..0000000000 --- a/types/gitlab/Models/Labels.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -export class Labels extends BaseModel { - create(projectId: TId, params?: object, fn?: Function): any; -} diff --git a/types/gitlab/Models/Notes.d.ts b/types/gitlab/Models/Notes.d.ts deleted file mode 100644 index 95b9cd623e..0000000000 --- a/types/gitlab/Models/Notes.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -export class Notes extends BaseModel { - create(projectId: TId, issueId: number, params?: object, fn?: Function): any; -} diff --git a/types/gitlab/Models/Pipelines.d.ts b/types/gitlab/Models/Pipelines.d.ts deleted file mode 100644 index f65a9e7d25..0000000000 --- a/types/gitlab/Models/Pipelines.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -export class Pipelines extends BaseModel { - all(projectId: TId, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectBuilds.d.ts b/types/gitlab/Models/ProjectBuilds.d.ts deleted file mode 100644 index df7c33c32a..0000000000 --- a/types/gitlab/Models/ProjectBuilds.d.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { BaseModel, TId, DefParams } from '../BaseModel'; - -interface IShowBuildParam { - projectId: TId; - [key: string]: any; -} - -export class ProjectBuilds extends BaseModel { - listBuilds(projectId: TId, fn?: Function): any; - listBuilds(projectId: TId, params?: DefParams, fn?: Function): any; - showBuild(projectId: TId, buildId: string, fn?: Function): any; - triggerBuild(params?: IShowBuildParam, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectDeployKeys.d.ts b/types/gitlab/Models/ProjectDeployKeys.d.ts deleted file mode 100644 index 3be9d66bc4..0000000000 --- a/types/gitlab/Models/ProjectDeployKeys.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -export class ProjectKeys extends BaseModel { - listKeys(projectId: TId, fn?: Function): any; - getKey(projectId: TId, keyId: number, fn?: Function): any; - addKey(projectId: TId, params?: object, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectHooks.d.ts b/types/gitlab/Models/ProjectHooks.d.ts deleted file mode 100644 index ce0878eec9..0000000000 --- a/types/gitlab/Models/ProjectHooks.d.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -interface IAddParam { - url: string; - [key: string]: any; -} - -type HooksCb = (hooks: any[]) => any; - -export class ProjectHooks extends BaseModel { - list(projectId: TId, fn?: HooksCb): any; - show(projectId: TId, hookId: number, fn?: Function): any; - add(projectId: TId, params: IAddParam | string, fn?: Function): any; - update(projectId: TId, hookId: number, url: string, fn?: Function): any; - remove(projectId: TId, hookId: number, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectIssues.d.ts b/types/gitlab/Models/ProjectIssues.d.ts deleted file mode 100644 index 8f7fc439a6..0000000000 --- a/types/gitlab/Models/ProjectIssues.d.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { IssueNotes } from './IssueNotes'; -import { BaseModel, TId, DefParams } from '../BaseModel'; - -export class ProjectIssues extends BaseModel { - readonly notes: IssueNotes; - - list(projectId: TId, fn?: Function): any; - list(projectId: TId, params?: DefParams, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectLabels.d.ts b/types/gitlab/Models/ProjectLabels.d.ts deleted file mode 100644 index 2f6ca1dabc..0000000000 --- a/types/gitlab/Models/ProjectLabels.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { BaseModel, TId, DefParams } from '../BaseModel'; - -export class ProjectLabels extends BaseModel { - all(projectId: TId, fn?: Function): any; - all(projectId: TId, params?: DefParams, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectMembers.d.ts b/types/gitlab/Models/ProjectMembers.d.ts deleted file mode 100644 index 25aa87332a..0000000000 --- a/types/gitlab/Models/ProjectMembers.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -type MenberCb = (menber: any) => any; -type MenbersCb = (menbers: any[]) => any; - -export class ProjectMembers extends BaseModel { - list(projectId: TId, fn?: MenbersCb): any; - show(projectId: TId, userId: number, fn?: MenberCb): any; - add(projectId: TId, userId: number, accessLevel: number,fn?: Function): any; - update(projectId: TId, userId: number, accessLevel: number, fn?: Function): any; - remove(projectId: TId, userId: number, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectMergeRequests.d.ts b/types/gitlab/Models/ProjectMergeRequests.d.ts deleted file mode 100644 index 37b2ab33e6..0000000000 --- a/types/gitlab/Models/ProjectMergeRequests.d.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { BaseModel, TId, DefParams } from '../BaseModel'; - -export class ProjectMergeRequests extends BaseModel { - list(projectId: TId, fn?: Function): any; - list(projectId: TId, params?: DefParams, fn?: Function): any; - show(projectId: TId, mergerequestId: number, fn?: Function): any; - add(projectId: TId, sourceBranch: string, targetBranch: string, assigneeId: number, title: string, fn?: Function): any; - update(projectId: TId, mergerequestId: number, params: object, fn?: Function): any; - comment(projectId: TId, mergerequestId: number, note: any, fn?: Function): any; - merge(projectId: TId, mergerequestId: number, params: object, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectMilestones.d.ts b/types/gitlab/Models/ProjectMilestones.d.ts deleted file mode 100644 index d36d1c016a..0000000000 --- a/types/gitlab/Models/ProjectMilestones.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -type MilestonesCb = (milestones: any[]) => any; -type MilestoneCb = (milestones: any) => any; - -export class ProjectMilestones extends BaseModel { - list(projectId: TId, fn?: MilestonesCb): any; - all(projectId: TId, fn?: MilestonesCb): any; - show(projectId: TId, milestoneId: number, fn?: MilestoneCb): any; - add(projectId: TId, title: string, description: string, due_date: any, fn?: Function): any; - update(projectId: TId, milestoneId: number, title: string, description: string, due_date: any, state_event: any, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectRepository.d.ts b/types/gitlab/Models/ProjectRepository.d.ts deleted file mode 100644 index 7bef1b6212..0000000000 --- a/types/gitlab/Models/ProjectRepository.d.ts +++ /dev/null @@ -1,39 +0,0 @@ -import { BaseModel, TId } from '../BaseModel'; - -interface ShowFileParams { - file_path: string; - ref?: any; - file_id?: any; - [key: string]: any; -} - -interface AddTagParams { - id: TId; - tag_name: string; - ref: string; - message?: string; - release_description?: string; -} - -export class ProjectRepository extends BaseModel { - listBranches(projectId: TId, fn?: Function): any; - showBranch(projectId: TId, branchId: string, fn?: Function): any; - protectBranch(projectId: TId, branchId: string, params: object, fn?: Function): any; - unprotectBranch(projectId: TId, branchId: string, fn?: Function): any; - createBranch(params: object, fn?: Function): any; - deleteBranch(projectId: TId, branchId: string, fn?: Function): any; - addTag(params: AddTagParams, fn?: Function): any; - deleteTag(projectId: TId, tagName: string, fn?: Function): any; - showTag(projectId: TId, tagName: string, fn?: Function): any; - listTags(projectId: TId, fn?: Function): any; - listCommits(projectId: TId, fn?: Function): any; - showCommit(projectId: TId, sha: string, fn?: Function): any; - diffCommit(projectId: TId, sha: string, fn?: Function): any; - listTree(projectId: TId, fn?: Function): any; - listTree(projectId: TId, params?: object, fn?: Function): any; - showFile(projectId: TId, fn?: Function): any; - showFile(projectId: TId, params?: ShowFileParams, fn?: Function): any; - createFile(params?: object, fn?: Function): any; - updateFile(params?: object, fn?: Function): any; - compare(params?: object, fn?: Function): any; -} diff --git a/types/gitlab/Models/ProjectServices.d.ts b/types/gitlab/Models/ProjectServices.d.ts deleted file mode 100644 index 25c59ae400..0000000000 --- a/types/gitlab/Models/ProjectServices.d.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { BaseModel, TId } from './../BaseModel'; - -type ServiceCb = (service: any) => any; - -export class ProjectServices extends BaseModel { - show(projectId: TId, serviceName: string, fn?: ServiceCb): any; - update(projectId: TId, serviceName: string, params: object, fn?: ServiceCb): any; - remove(projectId: TId, serviceName: string, fn?: ServiceCb): any; -} diff --git a/types/gitlab/Models/Projects.d.ts b/types/gitlab/Models/Projects.d.ts deleted file mode 100644 index 9ba8faa551..0000000000 --- a/types/gitlab/Models/Projects.d.ts +++ /dev/null @@ -1,55 +0,0 @@ -import { Runners } from './Runners'; -import { Pipelines } from './Pipelines'; -import { ProjectBuilds } from './ProjectBuilds'; -import { ProjectMergeRequests } from './ProjectMergeRequests'; -import { ProjectKeys } from './ProjectDeployKeys'; -import { ProjectMilestones } from './ProjectMilestones'; -import { ProjectRepository } from './ProjectRepository'; -import { ProjectLabels } from './ProjectLabels'; -import { ProjectIssues } from './ProjectIssues'; -import { ProjectHooks } from './ProjectHooks'; -import { ProjectMembers } from './ProjectMembers'; -import { BaseModel, DefParams, TId } from '../BaseModel'; -import { ProjectServices } from './ProjectServices'; - -type ProjectsCb = (projects: any[]) => any; - -export class Projects extends BaseModel { - - readonly members: ProjectMembers; - readonly hooks: ProjectHooks; - readonly issues: ProjectIssues; - readonly labels: ProjectLabels; - readonly repository: ProjectRepository; - readonly milestones: ProjectMilestones; - readonly deploy_keys: ProjectKeys; - readonly merge_requests: ProjectMergeRequests; - readonly services: ProjectServices; - readonly builds: ProjectBuilds; - readonly pipelines: Pipelines; - readonly runners: Runners; - - - all(fn?: ProjectsCb): any; - all(params?: DefParams, fn?: ProjectsCb): any; - allAdmin(fn?: Function): any; - allAdmin(params?: DefParams, fn?: Function): any; - show(projectId: TId, fn?: Function): any; - create(params: object, fn?: Function): any; - create_for_user(params: object, fn?: Function): any; - edit(projectId: TId, params: object, fn?: Function): any; - addMember(params?: object, fn?: Function): any; - editMember(params?: object, fn?: Function): any; - listMembers(params?: object, fn?: Function): any; - listCommits(params?: object, fn?: Function): any; - listTags(params?: object, fn?: Function): any; - remove(projectId: TId, fn?: Function): any; - fork(params?: object, fn?: Function): any; - share(params?: object, fn?: Function): any; - search(projectName: string, fn?: Function): any; - search(projectName: string, params?: object, fn?: Function): any; - listTriggers(projectId: TId, fn?: Function): any; - showTrigger(projectId: TId, token: string, fn?: Function): any; - createTrigger(params?: object, fn?: Function): any; - removeTrigger(projectId: TId, token: string, fn?: Function): any; -} diff --git a/types/gitlab/Models/Runners.d.ts b/types/gitlab/Models/Runners.d.ts deleted file mode 100644 index 1656fe0c5d..0000000000 --- a/types/gitlab/Models/Runners.d.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { BaseModel, DefParams, TId } from '../BaseModel'; - -export class Runners extends BaseModel { - all(projectId?: TId, fn?: Function): any; - all(projectId?: TId, params?: object, fn?: Function): any; - show(runnerId: number, fn?: Function): any; - update(runnerId: number, attributes: any, fn?: Function): any; - remove(runnerId: number, projectId: any, enable: any, fn?: Function): any; - enable(projectId: TId, runnerId: number, fn?: Function): any; - disable(projectId: TId, runnerId: number, fn?: Function): any; -} diff --git a/types/gitlab/Models/UserKeys.d.ts b/types/gitlab/Models/UserKeys.d.ts deleted file mode 100644 index 5182b5a2d1..0000000000 --- a/types/gitlab/Models/UserKeys.d.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { BaseModel, DefParams, TId } from '../BaseModel'; - -export class UserKeys extends BaseModel { - all(userId?: TId, fn?: Function): any; - addKey(userId: string, title: string, key: any, fn?: Function): any; -} diff --git a/types/gitlab/Models/Users.d.ts b/types/gitlab/Models/Users.d.ts deleted file mode 100644 index e4572ac659..0000000000 --- a/types/gitlab/Models/Users.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { BaseModel, DefParams, TId } from '../BaseModel'; -import { UserKeys } from './UserKeys'; - -type UsersCb = (users: any[]) => any; -type UserCb = (user: any) => any; - -export class Users extends BaseModel { - readonly keys: UserKeys; - - all(fn?: UsersCb): any; - all(params?: DefParams, fn?: UsersCb): any; - current(fn?: Function): any; - show(userId: number, fn?: UserCb): any; - create(params?: DefParams, fn?: Function): any; - session(email: string, password: string, fn?: Function): any; - search(emailOrUsername: string, fn?: Function): any; -} diff --git a/types/gitlab/gitlab-tests.ts b/types/gitlab/gitlab-tests.ts deleted file mode 100644 index 00ab2c761e..0000000000 --- a/types/gitlab/gitlab-tests.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as lib from "gitlab"; - -const gitlab = lib({ - url: 'http://example.com', - token: 'abcdefghij123456' -}); - -const v3 = new lib.ApiV3({ }); - -// From README - -// Listing users -gitlab.users.all((users) => { }); - -// Listing projects -gitlab.projects.all((projects) => { }); - -// From examples/delet-service - -gitlab.projects.services.remove("pid", "name", (service) => { }); diff --git a/types/gitlab/index.d.ts b/types/gitlab/index.d.ts deleted file mode 100644 index 1ff52505ee..0000000000 --- a/types/gitlab/index.d.ts +++ /dev/null @@ -1,17 +0,0 @@ -// Type definitions for gitlab 1.8 -// Project: https://github.com/node-gitlab/node-gitlab#readme -// Definitions by: sam -// AryloYeung -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.2 - -import { ApiV3 } from "./ApiV3"; -import { ApiBaseOptions } from "./ApiBase"; - -declare namespace Gitlib { - const ApiV3: new(options: ApiBaseOptions) => ApiV3; -} - -declare function Gitlib(options: ApiBaseOptions): ApiV3; - -export = Gitlib; diff --git a/types/gitlab/tsconfig.json b/types/gitlab/tsconfig.json deleted file mode 100644 index f1297faf67..0000000000 --- a/types/gitlab/tsconfig.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "strictFunctionTypes": true, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "gitlab-tests.ts" - ] -} diff --git a/types/gitlab/tslint.json b/types/gitlab/tslint.json deleted file mode 100644 index 4d35d29327..0000000000 --- a/types/gitlab/tslint.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "extends": "dtslint/dt.json", - "rules": { - // All are TODOs - "ban-types": false, - "interface-name": false, - "no-consecutive-blank-lines": false, - "no-padding": false, - "one-line": false, - "semicolon": false, - "strict-export-declare-modifiers": false, - "whitespace": false - } -} From 9cb83f7d867456ce599f0bef0f6db378150474b0 Mon Sep 17 00:00:00 2001 From: Paul Hobbel Date: Sun, 4 Nov 2018 17:51:29 +0100 Subject: [PATCH 018/271] Remove const before all enums --- types/youtube/index.d.ts | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/types/youtube/index.d.ts b/types/youtube/index.d.ts index b04d727378..5739e4c6fd 100644 --- a/types/youtube/index.d.ts +++ b/types/youtube/index.d.ts @@ -5,6 +5,7 @@ // Josh Goldberg // Eliot Fallon // Terry Mun +// Paul Hobbel // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 @@ -30,7 +31,7 @@ declare namespace YT /** * Known causes for player errors. */ - export const enum PlayerError + export enum PlayerError { /** * The request contained an invalid parameter value. @@ -61,7 +62,7 @@ declare namespace YT /** * Whether to auto-hide video controls. */ - export const enum AutoHide + export enum AutoHide { /** * Controls are visible throughout the video @@ -82,7 +83,7 @@ declare namespace YT /** * Whether to autoplay the video. */ - export const enum AutoPlay + export enum AutoPlay { /** * Video does not autoplay. @@ -98,7 +99,7 @@ declare namespace YT /** * Whether to use user-preferred or forced caption loading. */ - export const enum ClosedCaptionsLoadPolicy + export enum ClosedCaptionsLoadPolicy { /** * Defaults to the user's preferences. @@ -119,7 +120,7 @@ declare namespace YT /** * How video controls are shown. */ - export const enum Controls + export enum Controls { /** * Player controls do not display. @@ -140,7 +141,7 @@ declare namespace YT /** * Whether to allow keyboard controls. */ - export const enum KeyboardControls + export enum KeyboardControls { /** * Keyboard controls are enabled. @@ -156,7 +157,7 @@ declare namespace YT /** * Whether the JavaScript API should be enabled. */ - export const enum JsApi + export enum JsApi { /** * JavaScript API will be disabled. @@ -172,7 +173,7 @@ declare namespace YT /** * Whether to display the full-screen button. */ - export const enum FullscreenButton + export enum FullscreenButton { /** * The full screen button is hidden. @@ -188,7 +189,7 @@ declare namespace YT /** * Whether to show video annotations. */ - export const enum IvLoadPolicy + export enum IvLoadPolicy { /** * Video annotations will be shown. @@ -224,7 +225,7 @@ declare namespace YT /** * Whether a single video should be looped. */ - export const enum Loop + export enum Loop { /** * Video or playlist will be played only once. @@ -240,7 +241,7 @@ declare namespace YT /** * Comma separated list of video IDs to play after the URL path's video. */ - export const enum ModestBranding + export enum ModestBranding { /** * Player will contain full YouTube branding. @@ -256,7 +257,7 @@ declare namespace YT /** * Whether to playback video inline or full-screen in an HTML5 player on iOS */ - export const enum PlaysInline + export enum PlaysInline { /** * Playback in fullscreen. @@ -272,7 +273,7 @@ declare namespace YT /** * Whether to show related videos after the video finishes. */ - export const enum RelatedVideos + export enum RelatedVideos { /** * Hide related videos after playback is complete. @@ -288,7 +289,7 @@ declare namespace YT /** * Whether to show video information before playing. */ - export const enum ShowInfo + export enum ShowInfo { /** * Hide video title and uploader before video starts playing. From db9087e8cbb698b517a95019d2cba7ac84fc59bc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Mon, 5 Nov 2018 08:51:32 +0100 Subject: [PATCH 019/271] tests for all properties in v14 --- types/intl-tel-input/index.d.ts | 6 +++--- types/intl-tel-input/intl-tel-input-tests.ts | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index b0752632c3..424c454bac 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -21,10 +21,10 @@ export interface IntlTelInputStatic { * initialise the plugin with optional options. * @param options options that can be provided during initialization. */ - (node: Element, options?: IntlTelInputOptions): IntlTelInput; + (node: Element, options?: Options): Plugin; } -export interface IntlTelInput { +export interface Plugin { /** * Remove the plugin from the input, and unbind any event listeners. */ @@ -103,7 +103,7 @@ export interface IntlTelInput { setPlaceholderNumberType(type: NumberType): void; } -export interface IntlTelInputOptions { +export interface Options { /** * Whether or not to allow the dropdown. If disabled, there is no dropdown * arrow, and the selected flag is not clickable. Also we display the diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index 9a84e98428..fdba2811e1 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -1,4 +1,5 @@ import IntlTelInput = require("intl-tel-input"); +import { NumberFormat } from "intl-tel-input"; const input = document.querySelector("#phone"); window.intlTelInput(input); @@ -41,7 +42,13 @@ window.intlTelInput(input).setCountry('gb'); window.intlTelInput(input).setNumber('+447733123456'); +window.intlTelInput(input).setPlaceholderNumberType(IntlTelInput.NumberType.FIXED_LINE); + const countryData = window.intlTelInput.getCountryData(); +const country = countryData[0]; +const dialCode = country.dialCode; +const iso2 = country.iso2; +const name = country.name; window.intlTelInput.loadUtils('build/js/utils.js'); @@ -67,3 +74,16 @@ window.intlTelInput(input, { onlyCountries: ['al'], utilsScript: '../../build/js/utils.js' }); + +window.intlTelInput(input, { + allowDropdown: false, + autoHideDialCode: false, + autoPlaceholder: "aggressive", + dropdownContainer: document.body, + excludeCountries: [ "us", "uk" ], + formatOnDisplay: false, + hiddenInput: "hidden-input", + localizedCountries: { de: "Deutschland"}, + preferredCountries: ["us", "gb"], + separateDialCode: false +}); From 690c89a88b72e3022ca47513dffa3ac457312ec8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Mon, 5 Nov 2018 09:51:02 +0100 Subject: [PATCH 020/271] definitions and tests for jQuery-wrapped version --- types/intl-tel-input/index.d.ts | 2 +- types/intl-tel-input/intl-tel-input-tests.ts | 1 - types/intl-tel-input/jquery-wrapped-tests.ts | 89 +++++++++++++++ types/intl-tel-input/jquery-wrapped.d.ts | 109 +++++++++++++++++++ types/intl-tel-input/tsconfig.json | 4 +- types/intl-tel-input/tslint.json | 5 +- 6 files changed, 206 insertions(+), 4 deletions(-) create mode 100644 types/intl-tel-input/jquery-wrapped-tests.ts create mode 100644 types/intl-tel-input/jquery-wrapped.d.ts diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index 424c454bac..ebb0de032f 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -68,7 +68,7 @@ export interface Plugin { * Get more information about a validation error. * Requires the utilsScript option. * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.validationError + * global enum ValidationError */ getValidationError(): ValidationError; diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index fdba2811e1..57d5c2f9c9 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -1,5 +1,4 @@ import IntlTelInput = require("intl-tel-input"); -import { NumberFormat } from "intl-tel-input"; const input = document.querySelector("#phone"); window.intlTelInput(input); diff --git a/types/intl-tel-input/jquery-wrapped-tests.ts b/types/intl-tel-input/jquery-wrapped-tests.ts new file mode 100644 index 0000000000..0888d7c09e --- /dev/null +++ b/types/intl-tel-input/jquery-wrapped-tests.ts @@ -0,0 +1,89 @@ +/// + +import * as IntlTelInput from "intl-tel-input"; + +$('#phone').intlTelInput(); + +$('#phone').intlTelInput({ + customPlaceholder: (selectedCountryPlaceholder, selectedCountryData) => { + return 'e.g. ' + selectedCountryPlaceholder; + } +}); + +$('#phone').intlTelInput({ + placeholderNumberType: IntlTelInput.NumberType.MOBILE, +}); + +$('#phone').intlTelInput({ + geoIpLookup: (callback) => { + const countryCode = 'XY'; + callback(countryCode); + } +}); + +$('#phone').intlTelInput('destroy'); + +const extension = $('#phone').intlTelInput('getExtension'); + +const intlNumber = $('#phone').intlTelInput('getNumber'); +const ntlNumber = $('#phone').intlTelInput('getNumber', IntlTelInput.NumberFormat.NATIONAL); + +const numberType = $('#phone').intlTelInput('getNumberType'); +if (numberType === IntlTelInput.NumberType.MOBILE) {} + +const selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); + +const error = $('#phone').intlTelInput('getValidationError'); +if (error === IntlTelInput.ValidationError.TOO_SHORT) {} + +const isValid = $('#phone').intlTelInput('isValidNumber'); + +$('#phone').intlTelInput('setCountry', 'gb'); + +$('#phone').intlTelInput('setNumber', '+447733123456'); + +$('#phone').intlTelInput('setPlaceholderNumberType', IntlTelInput.NumberType.FIXED_LINE); + +const countryData = $.fn.intlTelInput.getCountryData(); +const country = countryData[0]; +const dialCode = country.dialCode; +const iso2 = country.iso2; +const name = country.name; + +$.fn.intlTelInput.loadUtils('build/js/utils.js'); + +$('#phone').intlTelInput({ + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + initialCountry: 'auto', + geoIpLookup: (callback) => { + const countryCode = 'XY'; + callback(countryCode); + }, + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + nationalMode: true, + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + onlyCountries: ['al'], + utilsScript: '../../build/js/utils.js' +}); + +$('#phone').intlTelInput({ + allowDropdown: false, + autoHideDialCode: false, + autoPlaceholder: "aggressive", + dropdownContainer: document.body, + excludeCountries: [ "us", "uk" ], + formatOnDisplay: false, + hiddenInput: "hidden-input", + localizedCountries: { de: "Deutschland"}, + preferredCountries: ["us", "gb"], + separateDialCode: false +}); diff --git a/types/intl-tel-input/jquery-wrapped.d.ts b/types/intl-tel-input/jquery-wrapped.d.ts new file mode 100644 index 0000000000..375fb32641 --- /dev/null +++ b/types/intl-tel-input/jquery-wrapped.d.ts @@ -0,0 +1,109 @@ +/// + +import { CountryData, NumberFormat, Options, NumberType, ValidationError } from "."; + +// Additional definitions for intl-tel-input (jQuery-wrapped) + +export interface JQueryPlugin { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): CountryData[]; + + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; + + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (options?: Options): JQueryDeferred; + + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + (method: 'destroy'): void; + + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + (method: 'getExtension'): string; + + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + (method: 'getNumber', numberFormat?: NumberFormat): string; + (method: string, numberFormat: NumberFormat): string; + + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + (method: 'getNumberType'): NumberType; + + /** + * Get the country data for the currently selected flag. + */ + (method: 'getSelectedCountryData'): CountryData; + + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum ValidationError + */ + (method: 'getValidationError'): ValidationError; + + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + (method: 'isValidNumber'): boolean; + + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + (method: 'setCountry', countryCode: string): void; + + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + (method: 'setNumber', aNumber: string): void; + + /** + * Set the type of the placeholder number + * @param type Placeholder number type to be set + */ + (method: 'setPlaceholderNumberType', type: NumberType): void; + } + +declare global { + interface JQuery { + intlTelInput: JQueryPlugin; + } +} diff --git a/types/intl-tel-input/tsconfig.json b/types/intl-tel-input/tsconfig.json index 380d60229d..88fae013ec 100644 --- a/types/intl-tel-input/tsconfig.json +++ b/types/intl-tel-input/tsconfig.json @@ -19,6 +19,8 @@ }, "files": [ "index.d.ts", - "intl-tel-input-tests.ts" + "jquery-wrapped.d.ts", + "intl-tel-input-tests.ts", + "jquery-wrapped-tests.ts" ] } \ No newline at end of file diff --git a/types/intl-tel-input/tslint.json b/types/intl-tel-input/tslint.json index f93cf8562a..08b1465cd6 100644 --- a/types/intl-tel-input/tslint.json +++ b/types/intl-tel-input/tslint.json @@ -1,3 +1,6 @@ { - "extends": "dtslint/dt.json" + "extends": "dtslint/dt.json", + "rules": { + "unified-signatures": false + } } From 4f78b8c5e1d62afc66c43a996ab2340f48981512 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Mon, 5 Nov 2018 10:26:26 +0100 Subject: [PATCH 021/271] formatting --- types/intl-tel-input/index.d.ts | 468 +++++++++--------- types/intl-tel-input/intl-tel-input-tests.ts | 62 +-- types/intl-tel-input/jquery-wrapped-tests.ts | 62 +-- types/intl-tel-input/jquery-wrapped.d.ts | 26 +- types/intl-tel-input/tsconfig.json | 2 +- types/intl-tel-input/v13/index.d.ts | 458 ++++++++--------- .../v13/intl-tel-input-tests.ts | 50 +- types/intl-tel-input/v13/tsconfig.json | 2 +- 8 files changed, 565 insertions(+), 565 deletions(-) diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index ebb0de032f..580a27d395 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -5,286 +5,286 @@ // TypeScript Version: 2.3 export interface IntlTelInputStatic { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): CountryData[]; + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): CountryData[]; - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (node: Element, options?: Options): Plugin; + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (node: Element, options?: Options): Plugin; } export interface Plugin { - /** - * Remove the plugin from the input, and unbind any event listeners. - */ - destroy(): void; + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + destroy(): void; - /** - * Get the extension from the current number. - * Requires the utilsScript option. - * e.g. if the input value was "(702) 555-5555 ext. 1234", this would - * return "1234". - */ - getExtension(): string; + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + getExtension(): string; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - * @param numberFormat the format in which the number will be returned. - */ - getNumber(numberFormat?: NumberFormat): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + getNumber(numberFormat?: NumberFormat): string; - /** - * Get the type (fixed-line/mobile/toll-free etc) of the current number. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.numberType. - * Note that in the US there's no way to differentiate between fixed-line and - * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. - */ - getNumberType(): NumberType; + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + getNumberType(): NumberType; - /** - * Get the country data for the currently selected flag. - */ - getSelectedCountryData(): CountryData; + /** + * Get the country data for the currently selected flag. + */ + getSelectedCountryData(): CountryData; - /** - * Get more information about a validation error. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum ValidationError - */ - getValidationError(): ValidationError; + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum ValidationError + */ + getValidationError(): ValidationError; - /** - * Validate the current number. Expects an internationally formatted number - * (unless nationalMode is enabled). If validation fails, you can use - * getValidationError to get more information. - * Requires the utilsScript option. - * Also see getNumberType if you want to make sure the user enters a certain - * type of number e.g. a mobile number. - */ - isValidNumber(): boolean; + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + isValidNumber(): boolean; - /** - * Change the country selection (e.g. when the user is entering their address). - * @param countryCode country code of the country to be set. - */ - setCountry(countryCode: string): void; + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + setCountry(countryCode: string): void; - /** - * Insert a number, and update the selected flag accordingly. - * Note that by default, if nationalMode is enabled it will try to use - * national formatting. - * @param aNumber number to be set. - */ - setNumber(aNumber: string): void; + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + setNumber(aNumber: string): void; - /** - * Set the type of the placeholder number - * @param type Placeholder number type to be set - */ - setPlaceholderNumberType(type: NumberType): void; + /** + * Set the type of the placeholder number + * @param type Placeholder number type to be set + */ + setPlaceholderNumberType(type: NumberType): void; } export interface Options { - /** - * Whether or not to allow the dropdown. If disabled, there is no dropdown - * arrow, and the selected flag is not clickable. Also we display the - * selected flag on the right instead because it is just a marker of state. - * Default = true - */ - allowDropdown?: boolean; + /** + * Whether or not to allow the dropdown. If disabled, there is no dropdown + * arrow, and the selected flag is not clickable. Also we display the + * selected flag on the right instead because it is just a marker of state. + * Default = true + */ + allowDropdown?: boolean; - /** - * If there is just a dial code in the input: remove it on blur or submit, - * and re-add it on focus. This is to prevent just a dial code getting - * submitted with the form. Requires nationalMode to be set to false. - * Default = true - */ - autoHideDialCode?: boolean; + /** + * If there is just a dial code in the input: remove it on blur or submit, + * and re-add it on focus. This is to prevent just a dial code getting + * submitted with the form. Requires nationalMode to be set to false. + * Default = true + */ + autoHideDialCode?: boolean; - /** - * Set the input's placeholder to an example number for the selected country, and update it if the country changes. - * You can specify the number type using the placeholderNumberType option. - * By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. - * You can also set it to "aggressive", which will replace any existing placeholder, or "off". - * Requires the utilsScript option. - * Default = "polite" - */ - autoPlaceholder?: "off" | "polite" | "aggressive"; + /** + * Set the input's placeholder to an example number for the selected country, and update it if the country changes. + * You can specify the number type using the placeholderNumberType option. + * By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. + * You can also set it to "aggressive", which will replace any existing placeholder, or "off". + * Requires the utilsScript option. + * Default = "polite" + */ + autoPlaceholder?: "off" | "polite" | "aggressive"; - /** - * Change the placeholder generated by autoPlaceholder. Must return a string. - * Default = null - */ - customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; + /** + * Change the placeholder generated by autoPlaceholder. Must return a string. + * Default = null + */ + customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; - /** - * Expects a node e.g. document.body. Instead of putting the country dropdown next to the input, - * append it to the specified node, and it will then be positioned absolutely next to the input using JavaScript. - * This is useful when the input is inside a container with overflow: hidden. - * Note that the absolute positioning can be broken by scrolling, so it will automatically close on the window scroll event. - * Default = null - */ - dropdownContainer?: Node; + /** + * Expects a node e.g. document.body. Instead of putting the country dropdown next to the input, + * append it to the specified node, and it will then be positioned absolutely next to the input using JavaScript. + * This is useful when the input is inside a container with overflow: hidden. + * Note that the absolute positioning can be broken by scrolling, so it will automatically close on the window scroll event. + * Default = null + */ + dropdownContainer?: Node; - /** - * In the dropdown, display all countries except the ones you specify here. - * Default = null - */ - excludeCountries?: string[]; + /** + * In the dropdown, display all countries except the ones you specify here. + * Default = null + */ + excludeCountries?: string[]; - /** - * Format the input value (according to the nationalMode option) during initialisation, and on setNumber. - * Requires the utilsScript option. - * Default = true - */ - formatOnDisplay?: boolean; + /** + * Format the input value (according to the nationalMode option) during initialisation, and on setNumber. + * Requires the utilsScript option. + * Default = true + */ + formatOnDisplay?: boolean; - /** - * When setting initialCountry to "auto", you must use this option to - * specify a custom function that looks up the user's location, - * and then calls the success callback with the relevant country code. - * Also note that when instantiating the plugin, if the Promise object is defined, - * one of those is returned under the promise instance property, so you can - * do something like iti.promise.then(callback) to know when initialisation requests like this have completed. - * Default = null - */ - geoIpLookup?: (callback: (countryCode: string) => void) => void; + /** + * When setting initialCountry to "auto", you must use this option to + * specify a custom function that looks up the user's location, + * and then calls the success callback with the relevant country code. + * Also note that when instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can + * do something like iti.promise.then(callback) to know when initialisation requests like this have completed. + * Default = null + */ + geoIpLookup?: (callback: (countryCode: string) => void) => void; - /** - * Add a hidden input with the given name (or if your input name contains square brackets then it will give the hidden input the same name, - * replacing the contents of the brackets with the given name). On submit, populate it with the full international number (using getNumber). - * This is a quick way for people using non-ajax forms to get the full international number, even when nationalMode is enabled. - * Note: requires the input to be inside a form element, as this feature works by listening for the submit event on the closest form element. - * Also note that since this uses getNumber internally, it expects a valid number, and so should only be used after validation. - * Default = "" - */ - hiddenInput?: string; + /** + * Add a hidden input with the given name (or if your input name contains square brackets then it will give the hidden input the same name, + * replacing the contents of the brackets with the given name). On submit, populate it with the full international number (using getNumber). + * This is a quick way for people using non-ajax forms to get the full international number, even when nationalMode is enabled. + * Note: requires the input to be inside a form element, as this feature works by listening for the submit event on the closest form element. + * Also note that since this uses getNumber internally, it expects a valid number, and so should only be used after validation. + * Default = "" + */ + hiddenInput?: string; - /** - * Set the initial country selection by specifying it's country code. - * You can also set it to "auto", which will lookup the user's country based - * on their IP address (requires the geoIpLookup option). - * Note that the "auto" option will not update the country selection if the - * input already contains a number. If you leave initialCountry blank, - * it will default to the first country in the list. - */ - initialCountry?: string; + /** + * Set the initial country selection by specifying it's country code. + * You can also set it to "auto", which will lookup the user's country based + * on their IP address (requires the geoIpLookup option). + * Note that the "auto" option will not update the country selection if the + * input already contains a number. If you leave initialCountry blank, + * it will default to the first country in the list. + */ + initialCountry?: string; - /** - * Allows to translate the countries by its given iso code e.g.: { 'de': 'Deutschland' } - * Default = {} - */ - localizedCountries?: object; + /** + * Allows to translate the countries by its given iso code e.g.: { 'de': 'Deutschland' } + * Default = {} + */ + localizedCountries?: object; - /** - * Allow users to enter national numbers (and not have to think about - * international dial codes). Formatting, validation and placeholders still - * work. Then you can use getNumber to extract a full international number. - * This option now defaults to true, and it is recommended that you leave it - * that way as it provides a better experience for the user. - * Default = true - */ - nationalMode?: boolean; + /** + * Allow users to enter national numbers (and not have to think about + * international dial codes). Formatting, validation and placeholders still + * work. Then you can use getNumber to extract a full international number. + * This option now defaults to true, and it is recommended that you leave it + * that way as it provides a better experience for the user. + * Default = true + */ + nationalMode?: boolean; - /** - * In the dropdown, display only the countries you specify. - * Default = undefined - */ - onlyCountries?: string[]; + /** + * In the dropdown, display only the countries you specify. + * Default = undefined + */ + onlyCountries?: string[]; - /** - * Specify one of the keys from the global enum intlTelInputUtils.numberType - * e.g. "FIXED_LINE" to set the number type to use for the placeholder. - * Default = MOBILE - */ - placeholderNumberType?: NumberType; + /** + * Specify one of the keys from the global enum intlTelInputUtils.numberType + * e.g. "FIXED_LINE" to set the number type to use for the placeholder. + * Default = MOBILE + */ + placeholderNumberType?: NumberType; - /** - * Specify the countries to appear at the top of the list. - * Default = ["us", "gb"] - */ - preferredCountries?: string[]; + /** + * Specify the countries to appear at the top of the list. + * Default = ["us", "gb"] + */ + preferredCountries?: string[]; - /** - * Display the country dial code next to the selected flag so it's not part - * of the typed number. Note that this will disable nationalMode because - * technically we are dealing with international numbers, but with the - * dial code separated. - * Default = false - */ - separateDialCode?: boolean; + /** + * Display the country dial code next to the selected flag so it's not part + * of the typed number. Note that this will disable nationalMode because + * technically we are dealing with international numbers, but with the + * dial code separated. + * Default = false + */ + separateDialCode?: boolean; - /** - * Enable formatting/validation etc. by specifying the URL of the included utils.js script - * (or alternatively just point it to the file on cdnjs.com). The script is fetched when the page has finished loading (on the window load event) - * to prevent blocking (the script is ~215KB). When instantiating the plugin, if the Promise object is defined, - * one of those is returned under the promise instance property, so you can do something like - * iti.promise.then(callback) to know when initialisation requests like this have finished. - * Note that if you're lazy loading the plugin script itself (intlTelInput.js) - * this will not work and you will need to use the loadUtils method instead. - * Example: "build/js/utils.js" - * Default = "" - */ - utilsScript?: string; + /** + * Enable formatting/validation etc. by specifying the URL of the included utils.js script + * (or alternatively just point it to the file on cdnjs.com). The script is fetched when the page has finished loading (on the window load event) + * to prevent blocking (the script is ~215KB). When instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can do something like + * iti.promise.then(callback) to know when initialisation requests like this have finished. + * Note that if you're lazy loading the plugin script itself (intlTelInput.js) + * this will not work and you will need to use the loadUtils method instead. + * Example: "build/js/utils.js" + * Default = "" + */ + utilsScript?: string; } export interface CountryData { - name: string; - iso2: string; - dialCode: string; + name: string; + iso2: string; + dialCode: string; } export enum NumberFormat { - E164 = 0, - INTERNATIONAL = 1, - NATIONAL = 2, - RFC3966 = 3 + E164 = 0, + INTERNATIONAL = 1, + NATIONAL = 2, + RFC3966 = 3 } export enum NumberType { - FIXED_LINE = 0, - MOBILE = 1, - FIXED_LINE_OR_MOBILE = 2, - TOLL_FREE = 3, - PREMIUM_RATE = 4, - SHARED_COST = 5, - VOIP = 6, - PERSONAL_NUMBER = 7, - PAGER = 8, - UAN = 9, - VOICEMAIL = 10, - UNKNOWN = -1 + FIXED_LINE = 0, + MOBILE = 1, + FIXED_LINE_OR_MOBILE = 2, + TOLL_FREE = 3, + PREMIUM_RATE = 4, + SHARED_COST = 5, + VOIP = 6, + PERSONAL_NUMBER = 7, + PAGER = 8, + UAN = 9, + VOICEMAIL = 10, + UNKNOWN = -1 } export enum ValidationError { - IS_POSSIBLE = 0, - INVALID_COUNTRY_CODE = 1, - TOO_SHORT = 2, - TOO_LONG = 3, - NOT_A_NUMBER = 4 + IS_POSSIBLE = 0, + INVALID_COUNTRY_CODE = 1, + TOO_SHORT = 2, + TOO_LONG = 3, + NOT_A_NUMBER = 4 } declare global { - interface Window { - intlTelInput: IntlTelInputStatic; - } + interface Window { + intlTelInput: IntlTelInputStatic; + } } diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index 57d5c2f9c9..8fcc76840b 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -4,20 +4,20 @@ const input = document.querySelector("#phone"); window.intlTelInput(input); window.intlTelInput(input, { - customPlaceholder(selectedCountryPlaceholder, selectedCountryData) { - return 'e.g. ' + selectedCountryPlaceholder; - } + customPlaceholder(selectedCountryPlaceholder, selectedCountryData) { + return 'e.g. ' + selectedCountryPlaceholder; + } }); window.intlTelInput(input, { - placeholderNumberType: IntlTelInput.NumberType.MOBILE, + placeholderNumberType: IntlTelInput.NumberType.MOBILE, }); window.intlTelInput(input, { - geoIpLookup(callback) { - const countryCode = 'XY'; - callback(countryCode); - } + geoIpLookup(callback) { + const countryCode = 'XY'; + callback(countryCode); + } }); window.intlTelInput(input).destroy(); @@ -28,12 +28,12 @@ const intlNumber = window.intlTelInput(input).getNumber(); const ntlNumber = window.intlTelInput(input).getNumber(IntlTelInput.NumberFormat.NATIONAL); const numberType = window.intlTelInput(input).getNumberType(); -if (numberType === IntlTelInput.NumberType.MOBILE) {} +if (numberType === IntlTelInput.NumberType.MOBILE) { } const selectedCountryData = window.intlTelInput(input).getSelectedCountryData(); const error = window.intlTelInput(input).getValidationError(); -if (error === IntlTelInput.ValidationError.TOO_SHORT) {} +if (error === IntlTelInput.ValidationError.TOO_SHORT) { } const isValid = window.intlTelInput(input).isValidNumber(); @@ -52,37 +52,37 @@ const name = country.name; window.intlTelInput.loadUtils('build/js/utils.js'); window.intlTelInput(input, { - utilsScript: '../../build/js/utils.js' + utilsScript: '../../build/js/utils.js' }); window.intlTelInput(input, { - initialCountry: 'auto', - geoIpLookup: (callback) => { - const countryCode = 'XY'; - callback(countryCode); - }, - utilsScript: '../../build/js/utils.js' + initialCountry: 'auto', + geoIpLookup: (callback) => { + const countryCode = 'XY'; + callback(countryCode); + }, + utilsScript: '../../build/js/utils.js' }); window.intlTelInput(input, { - nationalMode: true, - utilsScript: '../../build/js/utils.js' + nationalMode: true, + utilsScript: '../../build/js/utils.js' }); window.intlTelInput(input, { - onlyCountries: ['al'], - utilsScript: '../../build/js/utils.js' + onlyCountries: ['al'], + utilsScript: '../../build/js/utils.js' }); window.intlTelInput(input, { - allowDropdown: false, - autoHideDialCode: false, - autoPlaceholder: "aggressive", - dropdownContainer: document.body, - excludeCountries: [ "us", "uk" ], - formatOnDisplay: false, - hiddenInput: "hidden-input", - localizedCountries: { de: "Deutschland"}, - preferredCountries: ["us", "gb"], - separateDialCode: false + allowDropdown: false, + autoHideDialCode: false, + autoPlaceholder: "aggressive", + dropdownContainer: document.body, + excludeCountries: ["us", "uk"], + formatOnDisplay: false, + hiddenInput: "hidden-input", + localizedCountries: { de: "Deutschland" }, + preferredCountries: ["us", "gb"], + separateDialCode: false }); diff --git a/types/intl-tel-input/jquery-wrapped-tests.ts b/types/intl-tel-input/jquery-wrapped-tests.ts index 0888d7c09e..7fe6f0b3b7 100644 --- a/types/intl-tel-input/jquery-wrapped-tests.ts +++ b/types/intl-tel-input/jquery-wrapped-tests.ts @@ -5,20 +5,20 @@ import * as IntlTelInput from "intl-tel-input"; $('#phone').intlTelInput(); $('#phone').intlTelInput({ - customPlaceholder: (selectedCountryPlaceholder, selectedCountryData) => { - return 'e.g. ' + selectedCountryPlaceholder; - } + customPlaceholder: (selectedCountryPlaceholder, selectedCountryData) => { + return 'e.g. ' + selectedCountryPlaceholder; + } }); $('#phone').intlTelInput({ - placeholderNumberType: IntlTelInput.NumberType.MOBILE, + placeholderNumberType: IntlTelInput.NumberType.MOBILE, }); $('#phone').intlTelInput({ - geoIpLookup: (callback) => { - const countryCode = 'XY'; - callback(countryCode); - } + geoIpLookup: (callback) => { + const countryCode = 'XY'; + callback(countryCode); + } }); $('#phone').intlTelInput('destroy'); @@ -29,12 +29,12 @@ const intlNumber = $('#phone').intlTelInput('getNumber'); const ntlNumber = $('#phone').intlTelInput('getNumber', IntlTelInput.NumberFormat.NATIONAL); const numberType = $('#phone').intlTelInput('getNumberType'); -if (numberType === IntlTelInput.NumberType.MOBILE) {} +if (numberType === IntlTelInput.NumberType.MOBILE) { } const selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); const error = $('#phone').intlTelInput('getValidationError'); -if (error === IntlTelInput.ValidationError.TOO_SHORT) {} +if (error === IntlTelInput.ValidationError.TOO_SHORT) { } const isValid = $('#phone').intlTelInput('isValidNumber'); @@ -53,37 +53,37 @@ const name = country.name; $.fn.intlTelInput.loadUtils('build/js/utils.js'); $('#phone').intlTelInput({ - utilsScript: '../../build/js/utils.js' + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - initialCountry: 'auto', - geoIpLookup: (callback) => { - const countryCode = 'XY'; - callback(countryCode); - }, - utilsScript: '../../build/js/utils.js' + initialCountry: 'auto', + geoIpLookup: (callback) => { + const countryCode = 'XY'; + callback(countryCode); + }, + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - nationalMode: true, - utilsScript: '../../build/js/utils.js' + nationalMode: true, + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - onlyCountries: ['al'], - utilsScript: '../../build/js/utils.js' + onlyCountries: ['al'], + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - allowDropdown: false, - autoHideDialCode: false, - autoPlaceholder: "aggressive", - dropdownContainer: document.body, - excludeCountries: [ "us", "uk" ], - formatOnDisplay: false, - hiddenInput: "hidden-input", - localizedCountries: { de: "Deutschland"}, - preferredCountries: ["us", "gb"], - separateDialCode: false + allowDropdown: false, + autoHideDialCode: false, + autoPlaceholder: "aggressive", + dropdownContainer: document.body, + excludeCountries: ["us", "uk"], + formatOnDisplay: false, + hiddenInput: "hidden-input", + localizedCountries: { de: "Deutschland" }, + preferredCountries: ["us", "gb"], + separateDialCode: false }); diff --git a/types/intl-tel-input/jquery-wrapped.d.ts b/types/intl-tel-input/jquery-wrapped.d.ts index 375fb32641..e83e8285a1 100644 --- a/types/intl-tel-input/jquery-wrapped.d.ts +++ b/types/intl-tel-input/jquery-wrapped.d.ts @@ -1,6 +1,6 @@ /// -import { CountryData, NumberFormat, Options, NumberType, ValidationError } from "."; +import * as IntlTelInput from "./index"; // Additional definitions for intl-tel-input (jQuery-wrapped) @@ -9,7 +9,7 @@ export interface JQueryPlugin { * Get all of the plugin's country data - either to re-use elsewhere * e.g. to populate a country dropdown. */ - getCountryData(): CountryData[]; + getCountryData(): IntlTelInput.CountryData[]; /** * Load the utils.js script (included in the lib directory) to enable @@ -21,7 +21,7 @@ export interface JQueryPlugin { * initialise the plugin with optional options. * @param options options that can be provided during initialization. */ - (options?: Options): JQueryDeferred; + (options?: IntlTelInput.Options): JQueryDeferred; /** * Remove the plugin from the input, and unbind any event listeners. @@ -45,8 +45,8 @@ export interface JQueryPlugin { * international number. * @param numberFormat the format in which the number will be returned. */ - (method: 'getNumber', numberFormat?: NumberFormat): string; - (method: string, numberFormat: NumberFormat): string; + (method: 'getNumber', numberFormat?: IntlTelInput.NumberFormat): string; + (method: string, numberFormat: IntlTelInput.NumberFormat): string; /** * Get the type (fixed-line/mobile/toll-free etc) of the current number. @@ -56,12 +56,12 @@ export interface JQueryPlugin { * Note that in the US there's no way to differentiate between fixed-line and * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. */ - (method: 'getNumberType'): NumberType; + (method: 'getNumberType'): IntlTelInput.NumberType; /** * Get the country data for the currently selected flag. */ - (method: 'getSelectedCountryData'): CountryData; + (method: 'getSelectedCountryData'): IntlTelInput.CountryData; /** * Get more information about a validation error. @@ -69,7 +69,7 @@ export interface JQueryPlugin { * Returns an integer, which you can match against the various options in the * global enum ValidationError */ - (method: 'getValidationError'): ValidationError; + (method: 'getValidationError'): IntlTelInput.ValidationError; /** * Validate the current number. Expects an internationally formatted number @@ -99,11 +99,11 @@ export interface JQueryPlugin { * Set the type of the placeholder number * @param type Placeholder number type to be set */ - (method: 'setPlaceholderNumberType', type: NumberType): void; - } + (method: 'setPlaceholderNumberType', type: IntlTelInput.NumberType): void; +} declare global { - interface JQuery { - intlTelInput: JQueryPlugin; - } + interface JQuery { + intlTelInput: JQueryPlugin; + } } diff --git a/types/intl-tel-input/tsconfig.json b/types/intl-tel-input/tsconfig.json index 88fae013ec..5409f40b10 100644 --- a/types/intl-tel-input/tsconfig.json +++ b/types/intl-tel-input/tsconfig.json @@ -23,4 +23,4 @@ "intl-tel-input-tests.ts", "jquery-wrapped-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/intl-tel-input/v13/index.d.ts b/types/intl-tel-input/v13/index.d.ts index 34493a8b75..8221c73c62 100644 --- a/types/intl-tel-input/v13/index.d.ts +++ b/types/intl-tel-input/v13/index.d.ts @@ -8,253 +8,253 @@ declare namespace IntlTelInput { - interface Plugin { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): CountryData[]; - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; + interface Plugin { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): CountryData[]; + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; - /** - * Remove the plugin from the input, and unbind any event listeners. - */ - (method: 'destroy'): void; - /** - * Get the extension from the current number. - * Requires the utilsScript option. - * e.g. if the input value was "(702) 555-5555 ext. 1234", this would - * return "1234". - */ - (method: 'getExtension'): string; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - */ - (method: 'getNumber'): string; - /** - * Get the type (fixed-line/mobile/toll-free etc) of the current number. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.numberType. - * Note that in the US there's no way to differentiate between fixed-line and - * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. - */ - (method: 'getNumberType'): intlTelInputUtils.numberType; - /** - * Get the country data for the currently selected flag. - */ - (method: 'getSelectedCountryData'): IntlTelInput.CountryData; - /** - * Get more information about a validation error. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.validationError - */ - (method: 'getValidationError'): intlTelInputUtils.validationError; - /** - * Validate the current number. Expects an internationally formatted number - * (unless nationalMode is enabled). If validation fails, you can use - * getValidationError to get more information. - * Requires the utilsScript option. - * Also see getNumberType if you want to make sure the user enters a certain - * type of number e.g. a mobile number. - */ - (method: 'isValidNumber'): boolean; - (method: string): void; - /** - * Change the country selection (e.g. when the user is entering their address). - * @param countryCode country code of the country to be set. - */ - (method: 'setCountry', countryCode: string): void; - /** - * Insert a number, and update the selected flag accordingly. - * Note that by default, if nationalMode is enabled it will try to use - * national formatting. - * @param aNumber number to be set. - */ - (method: 'setNumber', aNumber: string): void; - (method: string, value: string): void; + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + (method: 'destroy'): void; + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + (method: 'getExtension'): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + */ + (method: 'getNumber'): string; + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + (method: 'getNumberType'): intlTelInputUtils.numberType; + /** + * Get the country data for the currently selected flag. + */ + (method: 'getSelectedCountryData'): IntlTelInput.CountryData; + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.validationError + */ + (method: 'getValidationError'): intlTelInputUtils.validationError; + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + (method: 'isValidNumber'): boolean; + (method: string): void; + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + (method: 'setCountry', countryCode: string): void; + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + (method: 'setNumber', aNumber: string): void; + (method: string, value: string): void; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - * @param numberFormat the format in which the number will be returned. - */ - (method: 'getNumber', numberFormat: intlTelInputUtils.numberFormat): string; - (method: string, numberFormat: intlTelInputUtils.numberFormat): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + (method: 'getNumber', numberFormat: intlTelInputUtils.numberFormat): string; + (method: string, numberFormat: intlTelInputUtils.numberFormat): string; - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (options?: IntlTelInput.Options): JQueryDeferred; - } + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (options?: IntlTelInput.Options): JQueryDeferred; + } - interface Options { - /** - * Whether or not to allow the dropdown. If disabled, there is no dropdown - * arrow, and the selected flag is not clickable. Also we display the - * selected flag on the right instead because it is just a marker of state. - */ - allowDropdown?: boolean; - /** - * If there is just a dial code in the input: remove it on blur or submit, - * and re-add it on focus. This is to prevent just a dial code getting - * submitted with the form. Requires nationalMode to be set to false. - */ - autoHideDialCode?: boolean; - /** - * Set the input's placeholder to an example number for the selected country. - * You can specify the number type using the numberType option. - * If there is already a placeholder attribute set on the input then that - * will take precedence. Requires the utilsScript option. - */ - autoPlaceholder?: boolean; - /** - * Change the placeholder generated by autoPlaceholder. Must return a string. - */ - customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; - /** - * Specify the container for the country dropdown (use a jQuery selector - * e.g. "body"). This is useful when the input is within a scrolling element, - * or an element with overflow: hidden. Wherever you put the dropdown it - * will automatically close on the window scroll event to prevent positioning - * issues. If you want it to close when a different element is scrolled - * (such as the input's parent), simply listen for the that scroll event, - * and trigger $(window).scroll() e.g. - */ - dropdownContainer?: string; - /** - * Don't display the countries you specify. - */ - excludeCountries?: Array; - /** - * Format the input value during initialisation. - */ - formatOnInit?: boolean; - /** - * When setting initialCountry to "auto", you must use this option to - * specify a custom function that looks up the user's location. Also note - * that when instantiating the plugin, we now return a deferred object, so - * you can use .done(callback) to know when initialisation requests like - * this have completed. - * Note that the callback must still be called in the event of an error. - */ - geoIpLookup?: (callback: (countryCode: string) => void) => void; - /** - * Set the initial country selection by specifying it's country code. - * You can also set it to "auto", which will lookup the user's country based - * on their IP address (requires the geoIpLookup option). - * Note that the "auto" option will not update the country selection if the - * input already contains a number. If you leave initialCountry blank, - * it will default to the first country in the list. - */ - initialCountry?: string; - /** - * Allow users to enter national numbers (and not have to think about - * international dial codes). Formatting, validation and placeholders still - * work. Then you can use getNumber to extract a full international number. - * This option now defaults to true, and it is recommended that you leave it - * that way as it provides a better experience for the user. - */ - nationalMode?: boolean; - /** - * Display only the countries you specify. - */ - onlyCountries?: Array; - /** - * Specify one of the keys from the global enum intlTelInputUtils.numberType - * e.g. "FIXED_LINE" to set the number type to use for the placeholder. - */ - placeholderNumberType?: - | "FIXED_LINE_OR_MOBILE" - | "FIXED_LINE" - | "MOBILE" - | "PAGER" - | "PERSONAL_NUMBER" - | "PREMIUM_RATE" - | "SHARED_COST" - | "TOLL_FREE" - | "UAN" - | "UNKNOWN" - | "VOICEMAIL" - | "VOIP"; - /** - * Specify the countries to appear at the top of the list. - */ - preferredCountries?: Array; - /** - * Display the country dial code next to the selected flag so it's not part - * of the typed number. Note that this will disable nationalMode because - * technically we are dealing with international numbers, but with the - * dial code separated. - */ - separateDialCode?: boolean; - /** - * Enable formatting/validation etc. by specifying the path to the included - * utils.js script, which is fetched only when the page has finished loading - * (on window.load) to prevent blocking. When instantiating the plugin, - * we return a deferred object, so you can use .done(callback) to know when - * initialisation requests like this have finished. Note that if you're - * lazy loading the plugin script itself (intlTelInput.js) this will not - * work and you will need to use the loadUtils method instead. - */ - utilsScript?: string; - } + interface Options { + /** + * Whether or not to allow the dropdown. If disabled, there is no dropdown + * arrow, and the selected flag is not clickable. Also we display the + * selected flag on the right instead because it is just a marker of state. + */ + allowDropdown?: boolean; + /** + * If there is just a dial code in the input: remove it on blur or submit, + * and re-add it on focus. This is to prevent just a dial code getting + * submitted with the form. Requires nationalMode to be set to false. + */ + autoHideDialCode?: boolean; + /** + * Set the input's placeholder to an example number for the selected country. + * You can specify the number type using the numberType option. + * If there is already a placeholder attribute set on the input then that + * will take precedence. Requires the utilsScript option. + */ + autoPlaceholder?: boolean; + /** + * Change the placeholder generated by autoPlaceholder. Must return a string. + */ + customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; + /** + * Specify the container for the country dropdown (use a jQuery selector + * e.g. "body"). This is useful when the input is within a scrolling element, + * or an element with overflow: hidden. Wherever you put the dropdown it + * will automatically close on the window scroll event to prevent positioning + * issues. If you want it to close when a different element is scrolled + * (such as the input's parent), simply listen for the that scroll event, + * and trigger $(window).scroll() e.g. + */ + dropdownContainer?: string; + /** + * Don't display the countries you specify. + */ + excludeCountries?: Array; + /** + * Format the input value during initialisation. + */ + formatOnInit?: boolean; + /** + * When setting initialCountry to "auto", you must use this option to + * specify a custom function that looks up the user's location. Also note + * that when instantiating the plugin, we now return a deferred object, so + * you can use .done(callback) to know when initialisation requests like + * this have completed. + * Note that the callback must still be called in the event of an error. + */ + geoIpLookup?: (callback: (countryCode: string) => void) => void; + /** + * Set the initial country selection by specifying it's country code. + * You can also set it to "auto", which will lookup the user's country based + * on their IP address (requires the geoIpLookup option). + * Note that the "auto" option will not update the country selection if the + * input already contains a number. If you leave initialCountry blank, + * it will default to the first country in the list. + */ + initialCountry?: string; + /** + * Allow users to enter national numbers (and not have to think about + * international dial codes). Formatting, validation and placeholders still + * work. Then you can use getNumber to extract a full international number. + * This option now defaults to true, and it is recommended that you leave it + * that way as it provides a better experience for the user. + */ + nationalMode?: boolean; + /** + * Display only the countries you specify. + */ + onlyCountries?: Array; + /** + * Specify one of the keys from the global enum intlTelInputUtils.numberType + * e.g. "FIXED_LINE" to set the number type to use for the placeholder. + */ + placeholderNumberType?: + | "FIXED_LINE_OR_MOBILE" + | "FIXED_LINE" + | "MOBILE" + | "PAGER" + | "PERSONAL_NUMBER" + | "PREMIUM_RATE" + | "SHARED_COST" + | "TOLL_FREE" + | "UAN" + | "UNKNOWN" + | "VOICEMAIL" + | "VOIP"; + /** + * Specify the countries to appear at the top of the list. + */ + preferredCountries?: Array; + /** + * Display the country dial code next to the selected flag so it's not part + * of the typed number. Note that this will disable nationalMode because + * technically we are dealing with international numbers, but with the + * dial code separated. + */ + separateDialCode?: boolean; + /** + * Enable formatting/validation etc. by specifying the path to the included + * utils.js script, which is fetched only when the page has finished loading + * (on window.load) to prevent blocking. When instantiating the plugin, + * we return a deferred object, so you can use .done(callback) to know when + * initialisation requests like this have finished. Note that if you're + * lazy loading the plugin script itself (intlTelInput.js) this will not + * work and you will need to use the loadUtils method instead. + */ + utilsScript?: string; + } - interface CountryData { - name: string; - iso2: string; - dialCode: string; - } + interface CountryData { + name: string; + iso2: string; + dialCode: string; + } } declare namespace intlTelInputUtils { const enum numberFormat { - E164 = 0, - INTERNATIONAL = 1, - NATIONAL = 2, - RFC3966 = 3 + E164 = 0, + INTERNATIONAL = 1, + NATIONAL = 2, + RFC3966 = 3 } const enum numberType { - FIXED_LINE = 0, - MOBILE = 1, - FIXED_LINE_OR_MOBILE = 2, - TOLL_FREE = 3, - PREMIUM_RATE = 4, - SHARED_COST = 5, - VOIP = 6, - PERSONAL_NUMBER = 7, - PAGER = 8, - UAN = 9, - VOICEMAIL = 10, - UNKNOWN = -1 + FIXED_LINE = 0, + MOBILE = 1, + FIXED_LINE_OR_MOBILE = 2, + TOLL_FREE = 3, + PREMIUM_RATE = 4, + SHARED_COST = 5, + VOIP = 6, + PERSONAL_NUMBER = 7, + PAGER = 8, + UAN = 9, + VOICEMAIL = 10, + UNKNOWN = -1 } const enum validationError { - IS_POSSIBLE = 0, - INVALID_COUNTRY_CODE = 1, - TOO_SHORT = 2, - TOO_LONG = 3, - NOT_A_NUMBER = 4 + IS_POSSIBLE = 0, + INVALID_COUNTRY_CODE = 1, + TOO_SHORT = 2, + TOO_LONG = 3, + NOT_A_NUMBER = 4 } } interface JQuery { - intlTelInput: IntlTelInput.Plugin; + intlTelInput: IntlTelInput.Plugin; } diff --git a/types/intl-tel-input/v13/intl-tel-input-tests.ts b/types/intl-tel-input/v13/intl-tel-input-tests.ts index e91a5deef1..497a8dff67 100644 --- a/types/intl-tel-input/v13/intl-tel-input-tests.ts +++ b/types/intl-tel-input/v13/intl-tel-input-tests.ts @@ -1,22 +1,22 @@ $('#phone').intlTelInput(); $('#phone').intlTelInput({ - customPlaceholder: function(selectedCountryPlaceholder, selectedCountryData) { - return 'e.g. ' + selectedCountryPlaceholder; - } + customPlaceholder: function (selectedCountryPlaceholder, selectedCountryData) { + return 'e.g. ' + selectedCountryPlaceholder; + } }); $('#phone').intlTelInput({ - placeholderNumberType: "MOBILE", + placeholderNumberType: "MOBILE", }); $('#phone').intlTelInput({ - geoIpLookup: function(callback) { - $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { - let countryCode = (resp && resp.country) ? resp.country : ''; - callback(countryCode); - }); - } + geoIpLookup: function (callback) { + $.get('http://ipinfo.io', function () { }, 'jsonp').always(function (resp) { + let countryCode = (resp && resp.country) ? resp.country : ''; + callback(countryCode); + }); + } }); $('#phone').intlTelInput('destroy'); @@ -27,12 +27,12 @@ let intlNumber = $('#phone').intlTelInput('getNumber'); let ntlNumber = $('#phone').intlTelInput('getNumber', intlTelInputUtils.numberFormat.NATIONAL); let numberType = $('#phone').intlTelInput('getNumberType'); -if (numberType === intlTelInputUtils.numberType.MOBILE) {} +if (numberType === intlTelInputUtils.numberType.MOBILE) { } let selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); let error = $('#phone').intlTelInput('getValidationError'); -if (error === intlTelInputUtils.validationError.TOO_SHORT) {} +if (error === intlTelInputUtils.validationError.TOO_SHORT) { } let isValid = $('#phone').intlTelInput('isValidNumber'); @@ -45,26 +45,26 @@ let countryData = $.fn.intlTelInput.getCountryData(); $.fn.intlTelInput.loadUtils('build/js/utils.js'); $('#phone').intlTelInput({ - utilsScript: '../../build/js/utils.js' + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - initialCountry: 'auto', - geoIpLookup: function(callback) { - $.get('http://ipinfo.io', function() {}, 'jsonp').always(function(resp) { - let countryCode = (resp && resp.country) ? resp.country : ''; - callback(countryCode); - }); - }, - utilsScript: '../../build/js/utils.js' + initialCountry: 'auto', + geoIpLookup: function (callback) { + $.get('http://ipinfo.io', function () { }, 'jsonp').always(function (resp) { + let countryCode = (resp && resp.country) ? resp.country : ''; + callback(countryCode); + }); + }, + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - nationalMode: true, - utilsScript: '../../build/js/utils.js' + nationalMode: true, + utilsScript: '../../build/js/utils.js' }); $('#phone').intlTelInput({ - onlyCountries: ['al'], - utilsScript: '../../build/js/utils.js' + onlyCountries: ['al'], + utilsScript: '../../build/js/utils.js' }); diff --git a/types/intl-tel-input/v13/tsconfig.json b/types/intl-tel-input/v13/tsconfig.json index b7e1b435b1..f166c4da54 100644 --- a/types/intl-tel-input/v13/tsconfig.json +++ b/types/intl-tel-input/v13/tsconfig.json @@ -24,4 +24,4 @@ "index.d.ts", "intl-tel-input-tests.ts" ] -} \ No newline at end of file +} From 829933ef2f2a7399b0bfb2c776608d6aa6f809d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Mon, 5 Nov 2018 10:57:06 +0100 Subject: [PATCH 022/271] use original names so minimal changes are required when updating --- types/intl-tel-input/index.d.ts | 508 ++++++++++--------- types/intl-tel-input/intl-tel-input-tests.ts | 14 +- types/intl-tel-input/jquery-wrapped-tests.ts | 34 +- types/intl-tel-input/jquery-wrapped.d.ts | 180 ++++--- 4 files changed, 366 insertions(+), 370 deletions(-) diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index 580a27d395..45ffbcfb12 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -4,287 +4,289 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 -export interface IntlTelInputStatic { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): CountryData[]; +declare namespace IntlTelInput { + interface Static { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): intlTelInputUtils.CountryData[]; - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (node: Element, options?: Options): Plugin; -} + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (node: Element, options?: Options): Plugin; + } -export interface Plugin { - /** - * Remove the plugin from the input, and unbind any event listeners. - */ - destroy(): void; + interface Plugin { + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + destroy(): void; - /** - * Get the extension from the current number. - * Requires the utilsScript option. - * e.g. if the input value was "(702) 555-5555 ext. 1234", this would - * return "1234". - */ - getExtension(): string; + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + getExtension(): string; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - * @param numberFormat the format in which the number will be returned. - */ - getNumber(numberFormat?: NumberFormat): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + getNumber(numberFormat?: intlTelInputUtils.numberFormat): string; - /** - * Get the type (fixed-line/mobile/toll-free etc) of the current number. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.numberType. - * Note that in the US there's no way to differentiate between fixed-line and - * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. - */ - getNumberType(): NumberType; + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + getNumberType(): intlTelInputUtils.numberType; - /** - * Get the country data for the currently selected flag. - */ - getSelectedCountryData(): CountryData; + /** + * Get the country data for the currently selected flag. + */ + getSelectedCountryData(): intlTelInputUtils.CountryData; - /** - * Get more information about a validation error. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum ValidationError - */ - getValidationError(): ValidationError; + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum ValidationError + */ + getValidationError(): intlTelInputUtils.validationError; - /** - * Validate the current number. Expects an internationally formatted number - * (unless nationalMode is enabled). If validation fails, you can use - * getValidationError to get more information. - * Requires the utilsScript option. - * Also see getNumberType if you want to make sure the user enters a certain - * type of number e.g. a mobile number. - */ - isValidNumber(): boolean; + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + isValidNumber(): boolean; - /** - * Change the country selection (e.g. when the user is entering their address). - * @param countryCode country code of the country to be set. - */ - setCountry(countryCode: string): void; + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + setCountry(countryCode: string): void; - /** - * Insert a number, and update the selected flag accordingly. - * Note that by default, if nationalMode is enabled it will try to use - * national formatting. - * @param aNumber number to be set. - */ - setNumber(aNumber: string): void; + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + setNumber(aNumber: string): void; - /** - * Set the type of the placeholder number - * @param type Placeholder number type to be set - */ - setPlaceholderNumberType(type: NumberType): void; -} + /** + * Set the type of the placeholder number + * @param type Placeholder number type to be set + */ + setPlaceholderNumberType(type: intlTelInputUtils.numberType): void; + } -export interface Options { - /** - * Whether or not to allow the dropdown. If disabled, there is no dropdown - * arrow, and the selected flag is not clickable. Also we display the - * selected flag on the right instead because it is just a marker of state. - * Default = true - */ - allowDropdown?: boolean; + interface Options { + /** + * Whether or not to allow the dropdown. If disabled, there is no dropdown + * arrow, and the selected flag is not clickable. Also we display the + * selected flag on the right instead because it is just a marker of state. + * Default = true + */ + allowDropdown?: boolean; - /** - * If there is just a dial code in the input: remove it on blur or submit, - * and re-add it on focus. This is to prevent just a dial code getting - * submitted with the form. Requires nationalMode to be set to false. - * Default = true - */ - autoHideDialCode?: boolean; + /** + * If there is just a dial code in the input: remove it on blur or submit, + * and re-add it on focus. This is to prevent just a dial code getting + * submitted with the form. Requires nationalMode to be set to false. + * Default = true + */ + autoHideDialCode?: boolean; - /** - * Set the input's placeholder to an example number for the selected country, and update it if the country changes. - * You can specify the number type using the placeholderNumberType option. - * By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. - * You can also set it to "aggressive", which will replace any existing placeholder, or "off". - * Requires the utilsScript option. - * Default = "polite" - */ - autoPlaceholder?: "off" | "polite" | "aggressive"; + /** + * Set the input's placeholder to an example number for the selected country, and update it if the country changes. + * You can specify the number type using the placeholderNumberType option. + * By default it is set to "polite", which means it will only set the placeholder if the input doesn't already have one. + * You can also set it to "aggressive", which will replace any existing placeholder, or "off". + * Requires the utilsScript option. + * Default = "polite" + */ + autoPlaceholder?: "off" | "polite" | "aggressive"; - /** - * Change the placeholder generated by autoPlaceholder. Must return a string. - * Default = null - */ - customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: CountryData) => string; + /** + * Change the placeholder generated by autoPlaceholder. Must return a string. + * Default = null + */ + customPlaceholder?: (selectedCountryPlaceholder: string, selectedCountryData: intlTelInputUtils.CountryData) => string; - /** - * Expects a node e.g. document.body. Instead of putting the country dropdown next to the input, - * append it to the specified node, and it will then be positioned absolutely next to the input using JavaScript. - * This is useful when the input is inside a container with overflow: hidden. - * Note that the absolute positioning can be broken by scrolling, so it will automatically close on the window scroll event. - * Default = null - */ - dropdownContainer?: Node; + /** + * Expects a node e.g. document.body. Instead of putting the country dropdown next to the input, + * append it to the specified node, and it will then be positioned absolutely next to the input using JavaScript. + * This is useful when the input is inside a container with overflow: hidden. + * Note that the absolute positioning can be broken by scrolling, so it will automatically close on the window scroll event. + * Default = null + */ + dropdownContainer?: Node; - /** - * In the dropdown, display all countries except the ones you specify here. - * Default = null - */ - excludeCountries?: string[]; + /** + * In the dropdown, display all countries except the ones you specify here. + * Default = null + */ + excludeCountries?: string[]; - /** - * Format the input value (according to the nationalMode option) during initialisation, and on setNumber. - * Requires the utilsScript option. - * Default = true - */ - formatOnDisplay?: boolean; + /** + * Format the input value (according to the nationalMode option) during initialisation, and on setNumber. + * Requires the utilsScript option. + * Default = true + */ + formatOnDisplay?: boolean; - /** - * When setting initialCountry to "auto", you must use this option to - * specify a custom function that looks up the user's location, - * and then calls the success callback with the relevant country code. - * Also note that when instantiating the plugin, if the Promise object is defined, - * one of those is returned under the promise instance property, so you can - * do something like iti.promise.then(callback) to know when initialisation requests like this have completed. - * Default = null - */ - geoIpLookup?: (callback: (countryCode: string) => void) => void; + /** + * When setting initialCountry to "auto", you must use this option to + * specify a custom function that looks up the user's location, + * and then calls the success callback with the relevant country code. + * Also note that when instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can + * do something like iti.promise.then(callback) to know when initialisation requests like this have completed. + * Default = null + */ + geoIpLookup?: (callback: (countryCode: string) => void) => void; - /** - * Add a hidden input with the given name (or if your input name contains square brackets then it will give the hidden input the same name, - * replacing the contents of the brackets with the given name). On submit, populate it with the full international number (using getNumber). - * This is a quick way for people using non-ajax forms to get the full international number, even when nationalMode is enabled. - * Note: requires the input to be inside a form element, as this feature works by listening for the submit event on the closest form element. - * Also note that since this uses getNumber internally, it expects a valid number, and so should only be used after validation. - * Default = "" - */ - hiddenInput?: string; + /** + * Add a hidden input with the given name (or if your input name contains square brackets then it will give the hidden input the same name, + * replacing the contents of the brackets with the given name). On submit, populate it with the full international number (using getNumber). + * This is a quick way for people using non-ajax forms to get the full international number, even when nationalMode is enabled. + * Note: requires the input to be inside a form element, as this feature works by listening for the submit event on the closest form element. + * Also note that since this uses getNumber internally, it expects a valid number, and so should only be used after validation. + * Default = "" + */ + hiddenInput?: string; - /** - * Set the initial country selection by specifying it's country code. - * You can also set it to "auto", which will lookup the user's country based - * on their IP address (requires the geoIpLookup option). - * Note that the "auto" option will not update the country selection if the - * input already contains a number. If you leave initialCountry blank, - * it will default to the first country in the list. - */ - initialCountry?: string; + /** + * Set the initial country selection by specifying it's country code. + * You can also set it to "auto", which will lookup the user's country based + * on their IP address (requires the geoIpLookup option). + * Note that the "auto" option will not update the country selection if the + * input already contains a number. If you leave initialCountry blank, + * it will default to the first country in the list. + */ + initialCountry?: string; - /** - * Allows to translate the countries by its given iso code e.g.: { 'de': 'Deutschland' } - * Default = {} - */ - localizedCountries?: object; + /** + * Allows to translate the countries by its given iso code e.g.: { 'de': 'Deutschland' } + * Default = {} + */ + localizedCountries?: object; - /** - * Allow users to enter national numbers (and not have to think about - * international dial codes). Formatting, validation and placeholders still - * work. Then you can use getNumber to extract a full international number. - * This option now defaults to true, and it is recommended that you leave it - * that way as it provides a better experience for the user. - * Default = true - */ - nationalMode?: boolean; + /** + * Allow users to enter national numbers (and not have to think about + * international dial codes). Formatting, validation and placeholders still + * work. Then you can use getNumber to extract a full international number. + * This option now defaults to true, and it is recommended that you leave it + * that way as it provides a better experience for the user. + * Default = true + */ + nationalMode?: boolean; - /** - * In the dropdown, display only the countries you specify. - * Default = undefined - */ - onlyCountries?: string[]; + /** + * In the dropdown, display only the countries you specify. + * Default = undefined + */ + onlyCountries?: string[]; - /** - * Specify one of the keys from the global enum intlTelInputUtils.numberType - * e.g. "FIXED_LINE" to set the number type to use for the placeholder. - * Default = MOBILE - */ - placeholderNumberType?: NumberType; + /** + * Specify one of the keys from the global enum intlTelInputUtils.numberType + * e.g. "FIXED_LINE" to set the number type to use for the placeholder. + * Default = MOBILE + */ + placeholderNumberType?: intlTelInputUtils.numberType; - /** - * Specify the countries to appear at the top of the list. - * Default = ["us", "gb"] - */ - preferredCountries?: string[]; + /** + * Specify the countries to appear at the top of the list. + * Default = ["us", "gb"] + */ + preferredCountries?: string[]; - /** - * Display the country dial code next to the selected flag so it's not part - * of the typed number. Note that this will disable nationalMode because - * technically we are dealing with international numbers, but with the - * dial code separated. - * Default = false - */ - separateDialCode?: boolean; + /** + * Display the country dial code next to the selected flag so it's not part + * of the typed number. Note that this will disable nationalMode because + * technically we are dealing with international numbers, but with the + * dial code separated. + * Default = false + */ + separateDialCode?: boolean; - /** - * Enable formatting/validation etc. by specifying the URL of the included utils.js script - * (or alternatively just point it to the file on cdnjs.com). The script is fetched when the page has finished loading (on the window load event) - * to prevent blocking (the script is ~215KB). When instantiating the plugin, if the Promise object is defined, - * one of those is returned under the promise instance property, so you can do something like - * iti.promise.then(callback) to know when initialisation requests like this have finished. - * Note that if you're lazy loading the plugin script itself (intlTelInput.js) - * this will not work and you will need to use the loadUtils method instead. - * Example: "build/js/utils.js" - * Default = "" - */ - utilsScript?: string; -} - -export interface CountryData { - name: string; - iso2: string; - dialCode: string; -} - -export enum NumberFormat { - E164 = 0, - INTERNATIONAL = 1, - NATIONAL = 2, - RFC3966 = 3 -} - -export enum NumberType { - FIXED_LINE = 0, - MOBILE = 1, - FIXED_LINE_OR_MOBILE = 2, - TOLL_FREE = 3, - PREMIUM_RATE = 4, - SHARED_COST = 5, - VOIP = 6, - PERSONAL_NUMBER = 7, - PAGER = 8, - UAN = 9, - VOICEMAIL = 10, - UNKNOWN = -1 -} - -export enum ValidationError { - IS_POSSIBLE = 0, - INVALID_COUNTRY_CODE = 1, - TOO_SHORT = 2, - TOO_LONG = 3, - NOT_A_NUMBER = 4 -} - -declare global { - interface Window { - intlTelInput: IntlTelInputStatic; + /** + * Enable formatting/validation etc. by specifying the URL of the included utils.js script + * (or alternatively just point it to the file on cdnjs.com). The script is fetched when the page has finished loading (on the window load event) + * to prevent blocking (the script is ~215KB). When instantiating the plugin, if the Promise object is defined, + * one of those is returned under the promise instance property, so you can do something like + * iti.promise.then(callback) to know when initialisation requests like this have finished. + * Note that if you're lazy loading the plugin script itself (intlTelInput.js) + * this will not work and you will need to use the loadUtils method instead. + * Example: "build/js/utils.js" + * Default = "" + */ + utilsScript?: string; } } + +declare namespace intlTelInputUtils { + interface CountryData { + name: string; + iso2: string; + dialCode: string; + } + + enum numberFormat { + E164 = 0, + INTERNATIONAL = 1, + NATIONAL = 2, + RFC3966 = 3 + } + + enum numberType { + FIXED_LINE = 0, + MOBILE = 1, + FIXED_LINE_OR_MOBILE = 2, + TOLL_FREE = 3, + PREMIUM_RATE = 4, + SHARED_COST = 5, + VOIP = 6, + PERSONAL_NUMBER = 7, + PAGER = 8, + UAN = 9, + VOICEMAIL = 10, + UNKNOWN = -1 + } + + enum validationError { + IS_POSSIBLE = 0, + INVALID_COUNTRY_CODE = 1, + TOO_SHORT = 2, + TOO_LONG = 3, + NOT_A_NUMBER = 4 + } +} + +interface Window { + intlTelInput: IntlTelInput.Static; +} diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index 8fcc76840b..58c5790342 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -1,5 +1,3 @@ -import IntlTelInput = require("intl-tel-input"); - const input = document.querySelector("#phone"); window.intlTelInput(input); @@ -10,7 +8,7 @@ window.intlTelInput(input, { }); window.intlTelInput(input, { - placeholderNumberType: IntlTelInput.NumberType.MOBILE, + placeholderNumberType: intlTelInputUtils.numberType.MOBILE, }); window.intlTelInput(input, { @@ -25,15 +23,15 @@ window.intlTelInput(input).destroy(); const extension = window.intlTelInput(input).getExtension(); const intlNumber = window.intlTelInput(input).getNumber(); -const ntlNumber = window.intlTelInput(input).getNumber(IntlTelInput.NumberFormat.NATIONAL); +const ntlNumber = window.intlTelInput(input).getNumber(intlTelInputUtils.numberFormat.NATIONAL); const numberType = window.intlTelInput(input).getNumberType(); -if (numberType === IntlTelInput.NumberType.MOBILE) { } +if (numberType === intlTelInputUtils.numberType.MOBILE) { } const selectedCountryData = window.intlTelInput(input).getSelectedCountryData(); const error = window.intlTelInput(input).getValidationError(); -if (error === IntlTelInput.ValidationError.TOO_SHORT) { } +if (error === intlTelInputUtils.validationError.TOO_SHORT) { } const isValid = window.intlTelInput(input).isValidNumber(); @@ -41,13 +39,13 @@ window.intlTelInput(input).setCountry('gb'); window.intlTelInput(input).setNumber('+447733123456'); -window.intlTelInput(input).setPlaceholderNumberType(IntlTelInput.NumberType.FIXED_LINE); +window.intlTelInput(input).setPlaceholderNumberType(intlTelInputUtils.numberType.FIXED_LINE); const countryData = window.intlTelInput.getCountryData(); const country = countryData[0]; const dialCode = country.dialCode; const iso2 = country.iso2; -const name = country.name; +const countryName = country.name; window.intlTelInput.loadUtils('build/js/utils.js'); diff --git a/types/intl-tel-input/jquery-wrapped-tests.ts b/types/intl-tel-input/jquery-wrapped-tests.ts index 7fe6f0b3b7..ad870e800b 100644 --- a/types/intl-tel-input/jquery-wrapped-tests.ts +++ b/types/intl-tel-input/jquery-wrapped-tests.ts @@ -1,7 +1,5 @@ /// -import * as IntlTelInput from "intl-tel-input"; - $('#phone').intlTelInput(); $('#phone').intlTelInput({ @@ -11,7 +9,7 @@ $('#phone').intlTelInput({ }); $('#phone').intlTelInput({ - placeholderNumberType: IntlTelInput.NumberType.MOBILE, + placeholderNumberType: intlTelInputUtils.numberType.MOBILE, }); $('#phone').intlTelInput({ @@ -23,32 +21,32 @@ $('#phone').intlTelInput({ $('#phone').intlTelInput('destroy'); -const extension = $('#phone').intlTelInput('getExtension'); +const jqueryExtension = $('#phone').intlTelInput('getExtension'); -const intlNumber = $('#phone').intlTelInput('getNumber'); -const ntlNumber = $('#phone').intlTelInput('getNumber', IntlTelInput.NumberFormat.NATIONAL); +const jqueryIntlNumber = $('#phone').intlTelInput('getNumber'); +const jqueryNtlNumber = $('#phone').intlTelInput('getNumber', intlTelInputUtils.numberFormat.NATIONAL); -const numberType = $('#phone').intlTelInput('getNumberType'); -if (numberType === IntlTelInput.NumberType.MOBILE) { } +const jqueryNumberType = $('#phone').intlTelInput('getNumberType'); +if (numberType === intlTelInputUtils.numberType.MOBILE) { } -const selectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); +const jquerySelectedCountryData = $('#phone').intlTelInput('getSelectedCountryData'); -const error = $('#phone').intlTelInput('getValidationError'); -if (error === IntlTelInput.ValidationError.TOO_SHORT) { } +const jqueryError = $('#phone').intlTelInput('getValidationError'); +if (error === intlTelInputUtils.validationError.TOO_SHORT) { } -const isValid = $('#phone').intlTelInput('isValidNumber'); +const jqueryIsValid = $('#phone').intlTelInput('isValidNumber'); $('#phone').intlTelInput('setCountry', 'gb'); $('#phone').intlTelInput('setNumber', '+447733123456'); -$('#phone').intlTelInput('setPlaceholderNumberType', IntlTelInput.NumberType.FIXED_LINE); +$('#phone').intlTelInput('setPlaceholderNumberType', intlTelInputUtils.numberType.FIXED_LINE); -const countryData = $.fn.intlTelInput.getCountryData(); -const country = countryData[0]; -const dialCode = country.dialCode; -const iso2 = country.iso2; -const name = country.name; +const jqueryCountryData = $.fn.intlTelInput.getCountryData(); +const jqueryCountry = countryData[0]; +const jqueryDialCode = country.dialCode; +const jqueryIso2 = country.iso2; +const jqueryName = country.name; $.fn.intlTelInput.loadUtils('build/js/utils.js'); diff --git a/types/intl-tel-input/jquery-wrapped.d.ts b/types/intl-tel-input/jquery-wrapped.d.ts index e83e8285a1..6a69404221 100644 --- a/types/intl-tel-input/jquery-wrapped.d.ts +++ b/types/intl-tel-input/jquery-wrapped.d.ts @@ -1,109 +1,107 @@ /// -import * as IntlTelInput from "./index"; - // Additional definitions for intl-tel-input (jQuery-wrapped) -export interface JQueryPlugin { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): IntlTelInput.CountryData[]; +declare namespace IntlTelInput { + interface JQueryPlugin { + /** + * Get all of the plugin's country data - either to re-use elsewhere + * e.g. to populate a country dropdown. + */ + getCountryData(): intlTelInputUtils.CountryData[]; - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; + /** + * Load the utils.js script (included in the lib directory) to enable + * formatting/validation etc. + */ + loadUtils(path: string, utilsScriptDeferred?: boolean): void; - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (options?: IntlTelInput.Options): JQueryDeferred; + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + (options?: Options): JQueryDeferred; - /** - * Remove the plugin from the input, and unbind any event listeners. - */ - (method: 'destroy'): void; + /** + * Remove the plugin from the input, and unbind any event listeners. + */ + (method: 'destroy'): void; - /** - * Get the extension from the current number. - * Requires the utilsScript option. - * e.g. if the input value was "(702) 555-5555 ext. 1234", this would - * return "1234". - */ - (method: 'getExtension'): string; + /** + * Get the extension from the current number. + * Requires the utilsScript option. + * e.g. if the input value was "(702) 555-5555 ext. 1234", this would + * return "1234". + */ + (method: 'getExtension'): string; - /** - * Get the current number in the given format (defaults to E.164 standard). - * The different formats are available in the enum - * intlTelInputUtils.numberFormat - taken from here. - * Requires the utilsScript option. - * Note that even if nationalMode is enabled, this can still return a full - * international number. - * @param numberFormat the format in which the number will be returned. - */ - (method: 'getNumber', numberFormat?: IntlTelInput.NumberFormat): string; - (method: string, numberFormat: IntlTelInput.NumberFormat): string; + /** + * Get the current number in the given format (defaults to E.164 standard). + * The different formats are available in the enum + * intlTelInputUtils.numberFormat - taken from here. + * Requires the utilsScript option. + * Note that even if nationalMode is enabled, this can still return a full + * international number. + * @param numberFormat the format in which the number will be returned. + */ + (method: 'getNumber', numberFormat?: intlTelInputUtils.numberFormat): string; + (method: string, numberFormat: intlTelInputUtils.numberFormat): string; - /** - * Get the type (fixed-line/mobile/toll-free etc) of the current number. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum intlTelInputUtils.numberType. - * Note that in the US there's no way to differentiate between fixed-line and - * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. - */ - (method: 'getNumberType'): IntlTelInput.NumberType; + /** + * Get the type (fixed-line/mobile/toll-free etc) of the current number. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum intlTelInputUtils.numberType. + * Note that in the US there's no way to differentiate between fixed-line and + * mobile numbers, so instead it will return FIXED_LINE_OR_MOBILE. + */ + (method: 'getNumberType'): intlTelInputUtils.numberType; - /** - * Get the country data for the currently selected flag. - */ - (method: 'getSelectedCountryData'): IntlTelInput.CountryData; + /** + * Get the country data for the currently selected flag. + */ + (method: 'getSelectedCountryData'): intlTelInputUtils.CountryData; - /** - * Get more information about a validation error. - * Requires the utilsScript option. - * Returns an integer, which you can match against the various options in the - * global enum ValidationError - */ - (method: 'getValidationError'): IntlTelInput.ValidationError; + /** + * Get more information about a validation error. + * Requires the utilsScript option. + * Returns an integer, which you can match against the various options in the + * global enum ValidationError + */ + (method: 'getValidationError'): intlTelInputUtils.validationError; - /** - * Validate the current number. Expects an internationally formatted number - * (unless nationalMode is enabled). If validation fails, you can use - * getValidationError to get more information. - * Requires the utilsScript option. - * Also see getNumberType if you want to make sure the user enters a certain - * type of number e.g. a mobile number. - */ - (method: 'isValidNumber'): boolean; + /** + * Validate the current number. Expects an internationally formatted number + * (unless nationalMode is enabled). If validation fails, you can use + * getValidationError to get more information. + * Requires the utilsScript option. + * Also see getNumberType if you want to make sure the user enters a certain + * type of number e.g. a mobile number. + */ + (method: 'isValidNumber'): boolean; - /** - * Change the country selection (e.g. when the user is entering their address). - * @param countryCode country code of the country to be set. - */ - (method: 'setCountry', countryCode: string): void; + /** + * Change the country selection (e.g. when the user is entering their address). + * @param countryCode country code of the country to be set. + */ + (method: 'setCountry', countryCode: string): void; - /** - * Insert a number, and update the selected flag accordingly. - * Note that by default, if nationalMode is enabled it will try to use - * national formatting. - * @param aNumber number to be set. - */ - (method: 'setNumber', aNumber: string): void; + /** + * Insert a number, and update the selected flag accordingly. + * Note that by default, if nationalMode is enabled it will try to use + * national formatting. + * @param aNumber number to be set. + */ + (method: 'setNumber', aNumber: string): void; - /** - * Set the type of the placeholder number - * @param type Placeholder number type to be set - */ - (method: 'setPlaceholderNumberType', type: IntlTelInput.NumberType): void; -} - -declare global { - interface JQuery { - intlTelInput: JQueryPlugin; + /** + * Set the type of the placeholder number + * @param type Placeholder number type to be set + */ + (method: 'setPlaceholderNumberType', type: intlTelInputUtils.numberType): void; } } + +interface JQuery { + intlTelInput: IntlTelInput.JQueryPlugin; +} From c4d1c5251066a1fce23ff7e7d2abe4fa056ad5be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Moln=C3=A1r?= Date: Mon, 5 Nov 2018 11:56:30 +0100 Subject: [PATCH 023/271] fixed statics --- types/intl-tel-input/index.d.ts | 19 ++++++++++++------- types/intl-tel-input/intl-tel-input-tests.ts | 4 ++-- types/intl-tel-input/jquery-wrapped-tests.ts | 4 ++-- types/intl-tel-input/jquery-wrapped.d.ts | 12 ------------ 4 files changed, 16 insertions(+), 23 deletions(-) diff --git a/types/intl-tel-input/index.d.ts b/types/intl-tel-input/index.d.ts index 45ffbcfb12..84f7bed50a 100644 --- a/types/intl-tel-input/index.d.ts +++ b/types/intl-tel-input/index.d.ts @@ -6,6 +6,11 @@ declare namespace IntlTelInput { interface Static { + /** + * Default options for all instances + */ + defaults: Options; + /** * Get all of the plugin's country data - either to re-use elsewhere * e.g. to populate a country dropdown. @@ -17,12 +22,6 @@ declare namespace IntlTelInput { * formatting/validation etc. */ loadUtils(path: string, utilsScriptDeferred?: boolean): void; - - /** - * initialise the plugin with optional options. - * @param options options that can be provided during initialization. - */ - (node: Element, options?: Options): Plugin; } interface Plugin { @@ -288,5 +287,11 @@ declare namespace intlTelInputUtils { } interface Window { - intlTelInput: IntlTelInput.Static; + intlTelInputGlobals: IntlTelInput.Static; + + /** + * initialise the plugin with optional options. + * @param options options that can be provided during initialization. + */ + intlTelInput(node: Element, options?: IntlTelInput.Options): IntlTelInput.Plugin; } diff --git a/types/intl-tel-input/intl-tel-input-tests.ts b/types/intl-tel-input/intl-tel-input-tests.ts index 58c5790342..9a8d68ee5d 100644 --- a/types/intl-tel-input/intl-tel-input-tests.ts +++ b/types/intl-tel-input/intl-tel-input-tests.ts @@ -41,13 +41,13 @@ window.intlTelInput(input).setNumber('+447733123456'); window.intlTelInput(input).setPlaceholderNumberType(intlTelInputUtils.numberType.FIXED_LINE); -const countryData = window.intlTelInput.getCountryData(); +const countryData = window.intlTelInputGlobals.getCountryData(); const country = countryData[0]; const dialCode = country.dialCode; const iso2 = country.iso2; const countryName = country.name; -window.intlTelInput.loadUtils('build/js/utils.js'); +window.intlTelInputGlobals.loadUtils('build/js/utils.js'); window.intlTelInput(input, { utilsScript: '../../build/js/utils.js' diff --git a/types/intl-tel-input/jquery-wrapped-tests.ts b/types/intl-tel-input/jquery-wrapped-tests.ts index ad870e800b..cd8eae1704 100644 --- a/types/intl-tel-input/jquery-wrapped-tests.ts +++ b/types/intl-tel-input/jquery-wrapped-tests.ts @@ -42,13 +42,13 @@ $('#phone').intlTelInput('setNumber', '+447733123456'); $('#phone').intlTelInput('setPlaceholderNumberType', intlTelInputUtils.numberType.FIXED_LINE); -const jqueryCountryData = $.fn.intlTelInput.getCountryData(); +const jqueryCountryData = window.intlTelInputGlobals.getCountryData(); const jqueryCountry = countryData[0]; const jqueryDialCode = country.dialCode; const jqueryIso2 = country.iso2; const jqueryName = country.name; -$.fn.intlTelInput.loadUtils('build/js/utils.js'); +window.intlTelInputGlobals.loadUtils('build/js/utils.js'); $('#phone').intlTelInput({ utilsScript: '../../build/js/utils.js' diff --git a/types/intl-tel-input/jquery-wrapped.d.ts b/types/intl-tel-input/jquery-wrapped.d.ts index 6a69404221..a95cbf2ba8 100644 --- a/types/intl-tel-input/jquery-wrapped.d.ts +++ b/types/intl-tel-input/jquery-wrapped.d.ts @@ -4,18 +4,6 @@ declare namespace IntlTelInput { interface JQueryPlugin { - /** - * Get all of the plugin's country data - either to re-use elsewhere - * e.g. to populate a country dropdown. - */ - getCountryData(): intlTelInputUtils.CountryData[]; - - /** - * Load the utils.js script (included in the lib directory) to enable - * formatting/validation etc. - */ - loadUtils(path: string, utilsScriptDeferred?: boolean): void; - /** * initialise the plugin with optional options. * @param options options that can be provided during initialization. From 99cf02c9a4a78f4ae60d00b5898b7c66a02ceef4 Mon Sep 17 00:00:00 2001 From: Konch Roman <300konya@gmail.com> Date: Mon, 5 Nov 2018 19:42:19 +0300 Subject: [PATCH 024/271] Add vscode local history plugin to ignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) 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 From eb24763f26b9d20f27b5dedd4455bdc9912a8fe0 Mon Sep 17 00:00:00 2001 From: Konch Roman <300konya@gmail.com> Date: Mon, 5 Nov 2018 22:12:15 +0300 Subject: [PATCH 025/271] Add definition for zrender library --- types/zrender/index.d.ts | 57 ++++++++++++++++++++++++++ types/zrender/tsconfig.json | 22 +++++++++++ types/zrender/tslint.json | 79 +++++++++++++++++++++++++++++++++++++ 3 files changed, 158 insertions(+) create mode 100644 types/zrender/index.d.ts create mode 100644 types/zrender/tsconfig.json create mode 100644 types/zrender/tslint.json diff --git a/types/zrender/index.d.ts b/types/zrender/index.d.ts new file mode 100644 index 0000000000..1bf5e5cddf --- /dev/null +++ b/types/zrender/index.d.ts @@ -0,0 +1,57 @@ +// Type definitions for zrender 4.0.4 +// Project: https://github.com/ecomfe/zrender +// Definitions by: Roman +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +declare namespace zrender { + type X = number; + type Y = number; + type X2 = number; + type Y2 = number; + type GlobalCoords = boolean; + type ColorStops = { + offset: number; + color: string; + }[]; + + /** + * x, y, x2, y2 are all percent from 0 to 1 + */ + interface LinearGradient { + + new ( + /** @default 0 */ + x?: X, + + /** @default 0 */ + y?: Y, + + /** @default 1 */ + x2?: X2, + + /** @default 0 */ + y2?: Y2, + + /** @default [] */ + colorStops?: ColorStops, + + /** @default false */ + globalCoord?: GlobalCoords, + ): { + type: 'linear'; + x: X; + y: Y; + x2: X2; + y2: Y2; + colorStops: ColorStops; + globalCoord: GlobalCoords; + + addColorStop(offset: number, color: string): void; + }; + } +} + +declare module 'zrender' { + export = zrender; +} diff --git a/types/zrender/tsconfig.json b/types/zrender/tsconfig.json new file mode 100644 index 0000000000..ecc22c8314 --- /dev/null +++ b/types/zrender/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts" + ] +} diff --git a/types/zrender/tslint.json b/types/zrender/tslint.json new file mode 100644 index 0000000000..a41bf5d19a --- /dev/null +++ b/types/zrender/tslint.json @@ -0,0 +1,79 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "adjacent-overload-signatures": false, + "array-type": false, + "arrow-return-shorthand": false, + "ban-types": false, + "callable-types": false, + "comment-format": false, + "dt-header": false, + "eofline": false, + "export-just-namespace": false, + "import-spacing": false, + "interface-name": false, + "interface-over-type-literal": false, + "jsdoc-format": false, + "max-line-length": false, + "member-access": false, + "new-parens": false, + "no-any-union": false, + "no-boolean-literal-compare": false, + "no-conditional-assignment": false, + "no-consecutive-blank-lines": false, + "no-construct": false, + "no-declare-current-package": false, + "no-duplicate-imports": false, + "no-duplicate-variable": false, + "no-empty-interface": false, + "no-for-in-array": false, + "no-inferrable-types": false, + "no-internal-module": false, + "no-irregular-whitespace": false, + "no-mergeable-namespace": false, + "no-misused-new": false, + "no-namespace": false, + "no-object-literal-type-assertion": false, + "no-padding": false, + "no-redundant-jsdoc": false, + "no-redundant-jsdoc-2": false, + "no-redundant-undefined": false, + "no-reference-import": false, + "no-relative-import-in-test": false, + "no-self-import": false, + "no-single-declare-module": false, + "no-string-throw": false, + "no-unnecessary-callback-wrapper": false, + "no-unnecessary-class": false, + "no-unnecessary-generics": false, + "no-unnecessary-qualifier": false, + "no-unnecessary-type-assertion": false, + "no-useless-files": false, + "no-var-keyword": false, + "no-var-requires": false, + "no-void-expression": false, + "no-trailing-whitespace": false, + "object-literal-key-quotes": false, + "object-literal-shorthand": false, + "one-line": false, + "one-variable-per-declaration": false, + "only-arrow-functions": false, + "prefer-conditional-expression": false, + "prefer-const": false, + "prefer-declare-function": false, + "prefer-for-of": false, + "prefer-method-signature": false, + "prefer-template": false, + "radix": false, + "semicolon": false, + "space-before-function-paren": false, + "space-within-parens": false, + "strict-export-declare-modifiers": false, + "trim-file": false, + "triple-equals": false, + "typedef-whitespace": false, + "unified-signatures": false, + "void-return": false, + "whitespace": false + } +} From aa2b6a7eb07ef7d6a6e7fc79d84a6e43e0202cd8 Mon Sep 17 00:00:00 2001 From: Konch Roman <300konya@gmail.com> Date: Mon, 5 Nov 2018 14:47:47 +0300 Subject: [PATCH 026/271] Enhance definition for echarts options Details: - add definition for tooltip - add definition for x and y axis - add definition for series this commit could lead to braking changes because it was written by official documentation that contains mistakes --- types/echarts/index.d.ts | 1036 +- types/echarts/options/axis-pointer.d.ts | 64 + types/echarts/options/data-zoom.d.ts | 106 + types/echarts/options/series/bar.d.ts | 16597 ++++++++++++ types/echarts/options/series/boxplot.d.ts | 13252 +++++++++ types/echarts/options/series/candlestick.d.ts | 13487 ++++++++++ types/echarts/options/series/custom.d.ts | 7949 ++++++ .../options/series/effect-scatter.d.ts | 16792 ++++++++++++ types/echarts/options/series/funnel.d.ts | 16488 ++++++++++++ types/echarts/options/series/gauge.d.ts | 14272 ++++++++++ types/echarts/options/series/graph.d.ts | 22092 ++++++++++++++++ types/echarts/options/series/heatmap.d.ts | 15348 +++++++++++ types/echarts/options/series/line.d.ts | 17082 ++++++++++++ types/echarts/options/series/lines.d.ts | 14931 +++++++++++ types/echarts/options/series/map.d.ts | 16402 ++++++++++++ types/echarts/options/series/parallel.d.ts | 1329 + .../echarts/options/series/pictorial-bar.d.ts | 17957 +++++++++++++ types/echarts/options/series/pie.d.ts | 16220 ++++++++++++ types/echarts/options/series/radar.d.ts | 5581 ++++ types/echarts/options/series/sankey.d.ts | 5252 ++++ types/echarts/options/series/scatter.d.ts | 16823 ++++++++++++ types/echarts/options/series/sunburst.d.ts | 12292 +++++++++ types/echarts/options/series/theme-river.d.ts | 2484 ++ types/echarts/options/series/tree.d.ts | 6960 +++++ types/echarts/options/series/treemap.d.ts | 14360 ++++++++++ types/echarts/options/text-style.d.ts | 24 + types/echarts/options/tooltip.d.ts | 443 + types/echarts/options/x-axis.d.ts | 39 + types/echarts/options/y-axis.d.ts | 37 + types/echarts/tsconfig.json | 30 +- 30 files changed, 285712 insertions(+), 17 deletions(-) create mode 100644 types/echarts/options/axis-pointer.d.ts create mode 100644 types/echarts/options/data-zoom.d.ts create mode 100644 types/echarts/options/series/bar.d.ts create mode 100644 types/echarts/options/series/boxplot.d.ts create mode 100644 types/echarts/options/series/candlestick.d.ts create mode 100644 types/echarts/options/series/custom.d.ts create mode 100644 types/echarts/options/series/effect-scatter.d.ts create mode 100644 types/echarts/options/series/funnel.d.ts create mode 100644 types/echarts/options/series/gauge.d.ts create mode 100644 types/echarts/options/series/graph.d.ts create mode 100644 types/echarts/options/series/heatmap.d.ts create mode 100644 types/echarts/options/series/line.d.ts create mode 100644 types/echarts/options/series/lines.d.ts create mode 100644 types/echarts/options/series/map.d.ts create mode 100644 types/echarts/options/series/parallel.d.ts create mode 100644 types/echarts/options/series/pictorial-bar.d.ts create mode 100644 types/echarts/options/series/pie.d.ts create mode 100644 types/echarts/options/series/radar.d.ts create mode 100644 types/echarts/options/series/sankey.d.ts create mode 100644 types/echarts/options/series/scatter.d.ts create mode 100644 types/echarts/options/series/sunburst.d.ts create mode 100644 types/echarts/options/series/theme-river.d.ts create mode 100644 types/echarts/options/series/tree.d.ts create mode 100644 types/echarts/options/series/treemap.d.ts create mode 100644 types/echarts/options/text-style.d.ts create mode 100644 types/echarts/options/tooltip.d.ts create mode 100644 types/echarts/options/x-axis.d.ts create mode 100644 types/echarts/options/y-axis.d.ts diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts index dc525231e6..804805379d 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 CommonProps { + interface Axis { + /** + * 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?: Axis.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?: Axis.Line; + + /** + * Settings related to axis tick. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisTick + */ + axisTick?: Axis.Tick; + + /** + * Settings related to axis label. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisLabel + */ + + axisLabel?: Axis.Label; + + /** + * SplitLine of axis in grid area. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.splitLine + */ + + splitLine?: Axis.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?: Axis.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?: Axis.Data[]; + + /** + * axisPointer settings on the axis. + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#yAxis.axisPointer + */ + axisPointer?: Axis.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 Axis { + 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 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; + }; + } + + /** + * @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 Data { + 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..603e2cdefc --- /dev/null +++ b/types/echarts/options/axis-pointer.d.ts @@ -0,0 +1,64 @@ +declare namespace echarts { + namespace EChartOption { + /** + * @todo describe + */ + interface AxisPointer extends CommonProps.Axis.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..07b47cac2d --- /dev/null +++ b/types/echarts/options/series/bar.d.ts @@ -0,0 +1,16597 @@ +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 { + [k: string]: any; + + /** + * @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?: SeriesBar.Data | SeriesBar.Data[]; + + /** + * 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 Data { + + /** + * 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..38952a0e02 --- /dev/null +++ b/types/echarts/options/series/boxplot.d.ts @@ -0,0 +1,13252 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/candlestick.d.ts b/types/echarts/options/series/candlestick.d.ts new file mode 100644 index 0000000000..f67e226361 --- /dev/null +++ b/types/echarts/options/series/candlestick.d.ts @@ -0,0 +1,13487 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/custom.d.ts b/types/echarts/options/series/custom.d.ts new file mode 100644 index 0000000000..0aaa4324d7 --- /dev/null +++ b/types/echarts/options/series/custom.d.ts @@ -0,0 +1,7949 @@ +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?: { + + /** + * 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; + + /** + * @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; + }; + }; + + /** + * `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; + }; + } + } +} 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..8b9b5eac69 --- /dev/null +++ b/types/echarts/options/series/effect-scatter.d.ts @@ -0,0 +1,16792 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/funnel.d.ts b/types/echarts/options/series/funnel.d.ts new file mode 100644 index 0000000000..a43b8f3960 --- /dev/null +++ b/types/echarts/options/series/funnel.d.ts @@ -0,0 +1,16488 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} 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..bbfa4ad84f --- /dev/null +++ b/types/echarts/options/series/graph.d.ts @@ -0,0 +1,22092 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/heatmap.d.ts b/types/echarts/options/series/heatmap.d.ts new file mode 100644 index 0000000000..1976c77ad3 --- /dev/null +++ b/types/echarts/options/series/heatmap.d.ts @@ -0,0 +1,15348 @@ +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?: { + + /** + * 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; + }; + }; + }; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/line.d.ts b/types/echarts/options/series/line.d.ts new file mode 100644 index 0000000000..60fcd01e65 --- /dev/null +++ b/types/echarts/options/series/line.d.ts @@ -0,0 +1,17082 @@ +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?: { + + /** + * 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; + }; + }; + + /** + * 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; + }; + } + } +} diff --git a/types/echarts/options/series/lines.d.ts b/types/echarts/options/series/lines.d.ts new file mode 100644 index 0000000000..fd740d69e6 --- /dev/null +++ b/types/echarts/options/series/lines.d.ts @@ -0,0 +1,14931 @@ +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?: { + + /** + * the name of data. + * + * + * @see https://ecomfe.github.io/echarts-doc/public/en/option.html#series-lines.data.name + */ + name?: string; + + /** + * 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; + }; + }; + }; + }; + }; + + /** + * 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; + } + } +} diff --git a/types/echarts/options/series/map.d.ts b/types/echarts/options/series/map.d.ts new file mode 100644 index 0000000000..417d9c3518 --- /dev/null +++ b/types/echarts/options/series/map.d.ts @@ -0,0 +1,16402 @@ +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 `