From 4ab95bd255d2c56c04fb52d6e5a0dcec34840238 Mon Sep 17 00:00:00 2001 From: bangbang93 Date: Thu, 5 Jul 2018 11:28:59 +0800 Subject: [PATCH 001/799] 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 abdca373e90201f817c2b20643e01d03a1eb0697 Mon Sep 17 00:00:00 2001 From: ptrdu Date: Wed, 26 Sep 2018 17:12:52 +0800 Subject: [PATCH 002/799] FEAT: add bucket operations --- types/ali-oss/ali-oss-tests.ts | 3 + types/ali-oss/index.d.ts | 247 +++++++++++++++++++++++++++++++++ types/ali-oss/tsconfig.json | 23 +++ types/ali-oss/tslint.json | 79 +++++++++++ 4 files changed, 352 insertions(+) create mode 100644 types/ali-oss/ali-oss-tests.ts create mode 100644 types/ali-oss/index.d.ts create mode 100644 types/ali-oss/tsconfig.json create mode 100644 types/ali-oss/tslint.json diff --git a/types/ali-oss/ali-oss-tests.ts b/types/ali-oss/ali-oss-tests.ts new file mode 100644 index 0000000000..3cf3229da9 --- /dev/null +++ b/types/ali-oss/ali-oss-tests.ts @@ -0,0 +1,3 @@ +import OSS from "ali-oss"; + +const client = new OSS(); diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts new file mode 100644 index 0000000000..b7c0f35067 --- /dev/null +++ b/types/ali-oss/index.d.ts @@ -0,0 +1,247 @@ +// Type definitions for ali-oss 6.0.1 +// Project: https://github.com/ali-sdk/ali-oss +// Definitions by: Ptrdu +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 3.2.0 + +export type Bucket = { + +} + +export type StorageType = "Standard" | "IA" | "Archive" + +export type ACLType = "public-read-write" | "public-read" | "and private" + +export type RequestOptions = { + // the operation timeout + timeout?: number +} + +export type RuleStatusType = "Enabled" | "Disabled" + +export type LifecycleRule = { + id?: string, // rule id, if not set, OSS will auto create it with random string. + prefix: string, // store prefix + status: RuleStatusType, // rule status, allow values: Enabled or Disabled + days?: number | string, // expire after the days + date: string // expire date, e.g.: 2022-10-11T00:00:00.000Z date and days only set one. +} + +export type CORSRule = { + allowedOrigin: string | Array, // configure for Access-Control-Allow-Origin header + allowedMethod: string | Array, // configure for Access-Control-Allow-Methods header + allowedHeader?: string | Array, // configure for Access-Control-Allow-Headers header + exposeHeader?: string | Array, // configure for Access-Control-Expose-Headers header + maxAgeSeconds?: string | Array, // configure for Access-Control-Max-Age header +} + +export interface NormalSuccessResponse { + //response status + status: number, + // response headers + headers: object, // todo the object in detail + // response size + size: number, + // request total use time (ms) + rt: number +} + +export default class OSS { + /******************************************* the bucket operations *************************************************/ + // base operators + /** + * List buckets in this account. + * @param {{prefix?: string; marker?: string; "max-keys"?: string | number} | null} query - query parameters, default is null + * prefix - search buckets using prefix key + * marker - search start from marker, including marker key + * max-keys - max buckets, default is 100, limit to 1000 + * @param {{timeout?: number}} options - optional parameters + * timeout - the operation timeout + * @return {Promise>} + */ + listBuckets(query: { prefix?: string, marker?: string, 'max-keys'?: string | number } | null, options?: { timeout?: number }): Promise> + + /** + * Create a new bucket. + * @param {string} name - bucket name If bucket exists and not belong to current account, will throw BucketAlreadyExistsError. If bucket not exists, will create a new bucket and set it's ACL. + * @param {{timeout: number; storageClass: StorageType}} options - optional parameters + * timeout - the operation timeout + * StorageClass - the storage type include (Standard,IA,Archive) + * @return { Promise<{ bucket: string, res: NormalSuccessResponse }> } + */ + putBucket(name: string, options?: { timeout: number, storageClass: StorageType }): Promise<{ bucket: string, res: NormalSuccessResponse }> + + /** + * Use the bucket. + * @param {string} name - bucket name + */ + useBucket(name: string) : void + + /** + * Delete an empty bucket. + * @param {string} name - bucket name If bucket is not empty, will throw BucketNotEmptyError. If bucket is not exists, will throw NoSuchBucketError. + * @param {RequestOptions} options + * @return {Promise} + */ + deleteBucket(name: string, options?: RequestOptions): Promise + + /** + * Get bucket information,include CreationDate、ExtranetEndpoint、IntranetEndpoint、Location、Name、StorageClass、 Owner、AccessControlList + * @param {string} name - bucket name + * @return {Promise} // todo the official document miss the return type + */ + getBucketInfo(name: string): Promise + + /** + * Get bucket location + * @param {string} name - bucket name + * @return {Promise} // todo the official document miss the return type + */ + getBucketLocation(name: string): Promise + // ACL operations + /** + * Update the bucket ACL. + * @param {string} name - bucket name + * @param {ACLType} acl - access control list, current available: public-read-write, public-read and private + * @param {RequestOptions} options + * @return {Promise} + */ + putBucketACL(name: string, acl: ACLType, options?: RequestOptions): Promise + + /** + * Get the bucket ACL. + * @param {string} name - bucket name + * @param {RequestOptions} options + * @return {Promise<{ acl: string, res: NormalSuccessResponse }>} + * acl - acl settings string + */ + getBucketACL(name: string, options?: RequestOptions ): Promise<{ acl: string, res: NormalSuccessResponse }> + // logging operations + /** + * Update the bucket logging settings. Log file will create every one hour and name format: -YYYY-mm-DD-HH-MM-SS-UniqueString. + * @param {string} name - bucket name + * @param {string} prefix - prefix path name to store the log files + * @param {RequestOptions} options + * @return {Promise} + */ + putBucketLogging(name: string, prefix?: string, options?: RequestOptions): Promise + + /** + * Get the bucket logging settings. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise<{ enable: boolean, prefix: string | null, res: NormalSuccessResponse }>} + */ + getBucketLogging(name: string, options?: RequestOptions): Promise<{ enable: boolean, prefix: string | null, res: NormalSuccessResponse }> + + /** + * Delete the bucket logging settings. + * @param {string} name - bucket name + * @param {RequestOptions} options + * @return {Promise} + */ + deleteBucketLogging(name: string, options?: RequestOptions) : Promise + // Website operations + /** + * Set the bucket as a static website. + * @param {string} name - bucket name + * @param {{index: string; error?: string}} config + * index - default page, e.g.: index.html + * error - error page, e.g.: 'error.html' + * @return {Promise} + */ + putBucketWebsite(name: string, config: { index: string, error?: string }): Promise + + /** + * Get the bucket website config. + * @param {string} name - bucket name + * @param {RequestOptions} options + * @return {Promise<{ index: string, error: string, res: NormalSuccessResponse }>} + */ + getBucketWebsite(name: string, options?: RequestOptions): Promise<{ index: string, error: string, res: NormalSuccessResponse }> + + /** + * Delete the bucket website config. + * @param {string} name - bucket name + * @param {RequestOptions} options + * @return {Promise} + */ + deleteBucketWebsite(name: string, options?: RequestOptions): Promise + // referer operations + /** + * Set the bucket request Referer white list. + * @param {string} name + * @param {boolean} allowEmpty - allow empty request referer or not + * @param {Array} referers - Referer white list, e.g.: ['https://npm.taobao.org', 'http://cnpmjs.org'] + * @param {RequestOptions} options + * @return {Promise} + */ + putBucketReferer(name: string, allowEmpty: boolean, referers: Array, options?: RequestOptions): Promise + + /** + * Get the bucket request Referer white list. + * @param {string} name - bucket name + * @param {RequestOptions} options + * @return {Promise<{ allowEmpty: boolean, referers: Array, res: NormalSuccessResponse }>} + */ + getBucketReferer(name: string, options?: RequestOptions): Promise<{ allowEmpty: boolean, referers: Array, res: NormalSuccessResponse }> + + /** + * Delete the bucket request Referer white list. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise} + */ + deleteBucketReferer(name: string, options?: RequestOptions): Promise + // lifecycle operations + /** + * Set the bucket object lifecycle. + * @param {string} name + * @param {Array} rules - rule config list + * @param {RequestOptions} options + * @return {Promise} + */ + putBucketLifecycle(name: string, rules: Array, options?: RequestOptions): Promise + + /** + * Get the bucket object lifecycle. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise<{ rules: Array, res: NormalSuccessResponse }>} + */ + getBucketLifecycle(name: string, options?: RequestOptions): Promise<{ rules: Array, res: NormalSuccessResponse }> + + /** + * Delete the bucket object lifecycle. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise} + */ + deleteBucketLifecycle(name: string, options?: RequestOptions): Promise + // CORS operations + /** + * Set CORS rules of the bucket object + * @param {string} name + * @param {Array} rules + * @param {RequestOptions} options + * @return {Promise} + */ + putBucketCORS(name: string, rules: Array, options?: RequestOptions): Promise + + /** + * Get CORS rules of the bucket object. + * @param {string} name + * @return {Promise<{rules: Array; res: NormalSuccessResponse}>} + */ + getBucketCORS(name: string): Promise<{ rules: Array, res: NormalSuccessResponse}> + + /** + * Delete CORS rules of the bucket object. + * @param {string} name + * @return {Promise} + */ + deleteBucketCORS(name: string): Promise + + /********************************************************** Object operations ********************************************/ + +} diff --git a/types/ali-oss/tsconfig.json b/types/ali-oss/tsconfig.json new file mode 100644 index 0000000000..a3e68ada2b --- /dev/null +++ b/types/ali-oss/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "ali-oss-tests.ts" + ] +} diff --git a/types/ali-oss/tslint.json b/types/ali-oss/tslint.json new file mode 100644 index 0000000000..a41bf5d19a --- /dev/null +++ b/types/ali-oss/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 3e6f81d1563df1c7a81548935eec22606469a106 Mon Sep 17 00:00:00 2001 From: ptrdu Date: Thu, 27 Sep 2018 11:14:53 +0800 Subject: [PATCH 003/799] FEAT: add function definition, current at object uploadPartCopy --- types/ali-oss/index.d.ts | 417 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 398 insertions(+), 19 deletions(-) diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index b7c0f35067..85708838d3 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -4,6 +4,8 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.2.0 +// general type + export type Bucket = { } @@ -12,6 +14,8 @@ export type StorageType = "Standard" | "IA" | "Archive" export type ACLType = "public-read-write" | "public-read" | "and private" +export type HTTPMethods = "GET" | "POST" | "DELETE" | "PUT"; + export type RequestOptions = { // the operation timeout timeout?: number @@ -35,7 +39,22 @@ export type CORSRule = { maxAgeSeconds?: string | Array, // configure for Access-Control-Max-Age header } -export interface NormalSuccessResponse { +export type OwnerType = { + id: string, + displayName: string +} + +export type ObjectMeta = { + name: string, // object name on oss + lastModified: string, // object last modified GMT date, e.g.: 2015-02-19T08:39:44.000Z + etag: string, // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" + type: string, // object type, e.g.: Normal + size: number, // object size, e.g.: 344606 + storageClass: StorageType, + owner: OwnerType, +} + +export type NormalSuccessResponse = { //response status status: number, // response headers @@ -46,36 +65,215 @@ export interface NormalSuccessResponse { rt: number } +export type UserMeta = { + uid: number, + pid: number +} + +export type ObjectCallback = { + url: string, // After a file is uploaded successfully, the OSS sends a callback request to this URL. + host?: string, // The host header value for initiating callback requests. + body: string, // The value of the request body when a callback is initiated, for example, key=$(key)&etag=$(etag)&my_var=$(x:my_var). + contentType?: string, // The Content-Type of the callback requests initiatiated, It supports application/x-www-form-urlencoded and application/json, and the former is the default value. + customValue?: object, + headers?: object // extra headers, detail see RFC 2616 +} + +export type ModifyData = { + lastModified: string, // object last modified GMT string + etag: string // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" +} + +// parameters type +export type ListBucketsQueryType = { + prefix?: string, // search buckets using prefix key + marker?: string, // search start from marker, including marker key + 'max-keys'?: string | number // max buckets, default is 100, limit to 1000 +} + +export type PutBucketOptions = { + timeout: number, + storageClass: StorageType +} + +export type PutBucketWebsiteConfig = { + index: string, // default page, e.g.: index.html + error?: string // error page, e.g.: 'error.html' +} + +export type ListObjectsQuery = { + prefix?: string, // search object using prefix key + marker?: string, // search start from marker, including marker key + delimiter?: string, // delimiter search scope e.g. / only search current dir, not including subdir + 'max-keys': string | number // max objects, default is 100, limit to 1000 +} + +export type ListObjectResult = { + objects: Array, + prefixes: Array, + isTruncated: boolean, + nextMarker: string, + res: NormalSuccessResponse +} + +export type PutObjectOptions = { + timeout?: number, // the operation timeout + mime?: string, // custom mime, will send with Content-Type entity header + meta?: UserMeta, // user meta, will send with x-oss-meta- prefix string e.g.: { uid: 123, pid: 110 } + callback: ObjectCallback, +} + +export type PutObjectResult = { + name: string, + data: object, + res: NormalSuccessResponse +} + +export type PutStreamOptions = { + contentLength?: number, // the stream length, chunked encoding will be used if absent + timeout: number, // the operation timeout + mime: string, // custom mime, will send with Content-Type entity header + meta: UserMeta, + callback: ObjectCallback +} + +export type AppendObjectOptions = { + position?: string, // specify the position which is the content length of the latest object + timeout?: number, // the operation timeout + mime?: string, // custom mime, will send with Content-Type entity header + meta?: UserMeta, + headers?: object +} + +export type AppendObjectResult = { + name: string, + url: string, // the url of oss + res: NormalSuccessResponse, + nextAppendPosition: string, // the next position +} + +export type HeadObjectOptions = { + timeout?: number, + headers?: object +} + +export type HeadObjectResult = { + status: number, // response status, maybe 200 or 304 + meta: UserMeta, + res: NormalSuccessResponse +} + +export type GetObjectOptions = { + timeout?: number, + process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} + headers?: object +} + +export type GetObjectResult = { + content?: any, // file content buffer if file parameter is null or ignore + res: NormalSuccessResponse +} + +export type GetStreamOptions = { + timeout?: number, + process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} + headers?: object +} + +export type GetStreamResult = { + stream?: any, // readable stream instance if response status is not 200, stream will be null. + res: NormalSuccessResponse +} + +export type CopyObjectOptions = { + timeout?: number, + meta?: UserMeta, + headers?: object +} + +export type CopyAndPutMetaResult = { + data: ModifyData, + res: NormalSuccessResponse +} + +export type DeleteMultiOptions = { + quite?: boolean // quiet mode or verbose mode, default is false, verbose mode quiet mode: if all objects delete succes, return emtpy response. otherwise return delete error object results. verbose mode: return all object delete results. + timeout?: number +} + +export type DeleteMultiResult = { + deleted?: Array // deleted object names list + res: NormalSuccessResponse +} + +export type ResponseHeaderType = { + 'content-type'?: string, + 'content-disposition'? :string, + 'cache-control'?: string +} + +export type SignatureUrlOptions = { + expires?: number, // after expires seconds, the url will become invalid, default is 1800 + method?: HTTPMethods, // the HTTP method, default is 'GET' + 'Content-Type'?: string, // set the request content type + process?: string, + response?: ResponseHeaderType, // set the response headers for download + callback?: ObjectCallback +} + +export type GetACLResult = { + acl: ACLType, + res: NormalSuccessResponse +} + +export type InitMultipartUploadOptions = { + timeout?: number, + mime?: string, // Mime file type + meta?: UserMeta, + headers?: object +} + +export type InitMultipartUploadResult = { + res: { status: number, headers: object, size: number, rt: number } + bucket: string, // bucket name + name: string, // object name store on OSS + uploadId: string, // upload id, use for uploadPart, completeMultipart +} + +export type UploadPartResult = { + name: string, + etag: string, + res: NormalSuccessResponse +} + export default class OSS { + // the image client + static ImageClient: any /******************************************* the bucket operations *************************************************/ + // base operators /** * List buckets in this account. - * @param {{prefix?: string; marker?: string; "max-keys"?: string | number} | null} query - query parameters, default is null - * prefix - search buckets using prefix key - * marker - search start from marker, including marker key - * max-keys - max buckets, default is 100, limit to 1000 - * @param {{timeout?: number}} options - optional parameters + * @param {ListBucketsQueryType | null} query - query parameters, default is null + * @param {RequestOptions} options - optional parameters * timeout - the operation timeout * @return {Promise>} */ - listBuckets(query: { prefix?: string, marker?: string, 'max-keys'?: string | number } | null, options?: { timeout?: number }): Promise> + listBuckets(query: ListBucketsQueryType | null, options?: RequestOptions): Promise> /** * Create a new bucket. * @param {string} name - bucket name If bucket exists and not belong to current account, will throw BucketAlreadyExistsError. If bucket not exists, will create a new bucket and set it's ACL. - * @param {{timeout: number; storageClass: StorageType}} options - optional parameters - * timeout - the operation timeout - * StorageClass - the storage type include (Standard,IA,Archive) + * @param {PutBucketOptions} options - optional parameters * @return { Promise<{ bucket: string, res: NormalSuccessResponse }> } */ - putBucket(name: string, options?: { timeout: number, storageClass: StorageType }): Promise<{ bucket: string, res: NormalSuccessResponse }> + putBucket(name: string, options?: PutBucketOptions): Promise<{ bucket: string, res: NormalSuccessResponse }> /** * Use the bucket. * @param {string} name - bucket name */ - useBucket(name: string) : void + useBucket(name: string): void /** * Delete an empty bucket. @@ -98,6 +296,7 @@ export default class OSS { * @return {Promise} // todo the official document miss the return type */ getBucketLocation(name: string): Promise + // ACL operations /** * Update the bucket ACL. @@ -115,7 +314,8 @@ export default class OSS { * @return {Promise<{ acl: string, res: NormalSuccessResponse }>} * acl - acl settings string */ - getBucketACL(name: string, options?: RequestOptions ): Promise<{ acl: string, res: NormalSuccessResponse }> + getBucketACL(name: string, options?: RequestOptions): Promise<{ acl: string, res: NormalSuccessResponse }> + // logging operations /** * Update the bucket logging settings. Log file will create every one hour and name format: -YYYY-mm-DD-HH-MM-SS-UniqueString. @@ -140,17 +340,16 @@ export default class OSS { * @param {RequestOptions} options * @return {Promise} */ - deleteBucketLogging(name: string, options?: RequestOptions) : Promise + deleteBucketLogging(name: string, options?: RequestOptions): Promise + // Website operations /** * Set the bucket as a static website. * @param {string} name - bucket name - * @param {{index: string; error?: string}} config - * index - default page, e.g.: index.html - * error - error page, e.g.: 'error.html' + * @param {PutBucketWebsiteConfig} config * @return {Promise} */ - putBucketWebsite(name: string, config: { index: string, error?: string }): Promise + putBucketWebsite(name: string, config: PutBucketWebsiteConfig): Promise /** * Get the bucket website config. @@ -167,6 +366,7 @@ export default class OSS { * @return {Promise} */ deleteBucketWebsite(name: string, options?: RequestOptions): Promise + // referer operations /** * Set the bucket request Referer white list. @@ -193,6 +393,7 @@ export default class OSS { * @return {Promise} */ deleteBucketReferer(name: string, options?: RequestOptions): Promise + // lifecycle operations /** * Set the bucket object lifecycle. @@ -218,6 +419,7 @@ export default class OSS { * @return {Promise} */ deleteBucketLifecycle(name: string, options?: RequestOptions): Promise + // CORS operations /** * Set CORS rules of the bucket object @@ -233,7 +435,7 @@ export default class OSS { * @param {string} name * @return {Promise<{rules: Array; res: NormalSuccessResponse}>} */ - getBucketCORS(name: string): Promise<{ rules: Array, res: NormalSuccessResponse}> + getBucketCORS(name: string): Promise<{ rules: Array, res: NormalSuccessResponse }> /** * Delete CORS rules of the bucket object. @@ -243,5 +445,182 @@ export default class OSS { deleteBucketCORS(name: string): Promise /********************************************************** Object operations ********************************************/ + /** + * List objects in the bucket. + * @param {ListObjectsQuery | null} query + * @param {RequestOptions} options + * @return {Promise} + */ + list(query: ListObjectsQuery | null, options: RequestOptions): Promise + + /** + * Add an object to the bucket. + * @param {string} name - object name store on OSS + * @param file - {String|Buffer|ReadStream|File(only support Browser)|Blob(only support Browser)} object local path, content buffer or ReadStream content instance use in Node, Blob and html5 File + * @param {PutObjectOptions} options - optional parameters + * @return {Promise} + */ + put(name: string, file: any, options?: PutObjectOptions): Promise + + /** + * Add a stream object to the bucket. + * @param {string} name - object name store on OSS + * @param stream - object ReadStream content instance + * @param {PutStreamOptions} options - optional parameters + * @return {Promise<{name: string; res: NormalSuccessResponse}>} + */ + putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }> + + /** + * Append an object to the bucket, it's almost same as put, but it can add content to existing object rather than override it. + * @param {string} name + * @param file + * @param {AppendObjectOptions} options + * @return {Promise} + */ + append(name: string, file: any, options?: AppendObjectOptions): Promise + + /** + * Get the Object url. If provide baseUrl, will use baseUrl instead the default endpoint. + * @param {string} name + * @param {string} baseUrl + * @return {string} + */ + getObjectUrl(name: string, baseUrl?: string): string + + /** + * Get the Object url. If provide baseUrl, will use baseUrl instead the default bucket and endpoint. Suggest use generateObjectUrl instead of getObjectUrl. + * @param {string} name + * @param {string} baseUrl + * @return {string} + */ + generateObjectUrl(name: string, baseUrl?: string): string + + /** + * Head an object and get the meta info. + * @param {string} name + * @param {HeadObjectOptions} options + * @return {Promise} + */ + head(name: string, options?: HeadObjectOptions): Promise + + /** + * Get an object from the bucket. + * @param {string} name + * @param file - {String|WriteStream} file path or WriteStream instance to store the content If file is null or ignore this parameter, function will return info contains content property. + * @param {GetObjectOptions} options + * @return {Promise} + */ + get(name: string, file?: any, options?: GetObjectOptions): Promise + + /** + * Get an object read stream. + * @param {string} name + * @param {GetStreamOptions} options + * @return {Promise} + */ + getStream(name?: string, options?: GetStreamOptions): Promise + + /** + * Delete an object from the bucket. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise} + */ + delete(name: string, options?: RequestOptions): Promise + + /** + * Copy an object from sourceName to name. + * @param {string} name - object name store on OSS + * @param {string} sourceName - source object name If sourceName start with /, meaning it's a full name contains the bucket name. e.g.: /otherbucket/logo.png meaning copy otherbucket logn.png object to current bucket. + * @param {CopyObjectOptions} options + * @return {Promise} + */ + copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise + + /** + * Set an exists object meta. + * @param {string} name + * @param {UserMeta} meta + * @param {RequestOptions} options + * @return {Promise} + */ + putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise + + /** + * Delete multi objects in one request. + * @param {Array} names - object names, max 1000 objects in once. + * @param {DeleteMultiOptions} options + * @return {Promise} + */ + deleteMulti(names: Array, options?: DeleteMultiOptions): Promise + + /** + * Create a signature url for download or upload object. When you put object with signatureUrl ,you need to pass Content-Type.Please look at the example. + * @param {string} name + * @param {SignatureUrlOptions} options + * @return {string} + */ + signatureUrl(name: string, options?: SignatureUrlOptions): string + + /** + * Set object's ACL. + * @param {string} name + * @param {ACLType} acl + * @param {RequestOptions} options + * @return {Promise} + */ + putACL(name: string, acl: ACLType, options?: RequestOptions): Promise + + /** + * Get object's ACL. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise} + */ + getACL(name:string, options?: RequestOptions): Promise + + /** + * Restore Object. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise} + */ + restore(name: string, options?: RequestOptions): Promise + + /** + * + * @param {string} name + * @param {InitMultipartUploadOptions} options + * @return {Promise} + */ + initMultipartUpload(name: string, options?: InitMultipartUploadOptions): Promise + + /** + * After initiating a Multipart Upload event, you can upload data in parts based on the specified object name and Upload ID. + * @param {string} name - object name + * @param {string} uploadId - get by initMultipartUpload api + * @param {number} partNo - range is 1-10000, If this range is exceeded, OSS returns the InvalidArgument's error code. + * @param file - is File or FileName, the whole file + Multipart Upload requires that the size of any Part other than the last Part is greater than 100KB. + In Node you can use File or FileName, but in browser you only can use File. + * @param {number} start - part start bytes e.g: 102400 + * @param {number} end - part end bytes e.g: 204800 + * @param {RequestOptions} options + * @return {Promise} + */ + uploadPart(name: string, uploadId: string, partNo: number, file: any, start: number, end: number, options?: RequestOptions): Promise + + /** + * Using Upload Part Copy, you can copy data from an existing object and upload a part of the data. When copying a file larger than 1 GB, you must use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object. + * @param {string} name + * @param {string} uploadId + * @param {number} partNo + * @param {string} range + * @param {{sourceKey: string; sourceBucketName: string}} sourceData + * @param {{timeout?: number; headers?: object}} options + * @return {Promise} + */ + uploadPartCopy(name: string, uploadId: string, partNo: number, range: string, sourceData: { sourceKey: string, sourceBucketName: string }, options: { timeout?: number, headers?: object }): Promise } From 5992ddd064ff74c68e9c32c13fc823ca31a51744 Mon Sep 17 00:00:00 2001 From: ptrdu Date: Thu, 27 Sep 2018 15:09:50 +0800 Subject: [PATCH 004/799] FEAT: add object operations definitions --- types/ali-oss/index.d.ts | 165 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index 85708838d3..fc0ff41ae1 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -84,6 +84,28 @@ export type ModifyData = { etag: string // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" } +export type Checkpoint = { + file: any, // The file object selected by the user, if the browser is restarted, it needs the user to manually trigger the settings + name: string, // object key + fileSize: number, + partSize: number, + uploadId: string, + doneParts: Array<{ number: number, etag: string }> +} + +export type ObjectPart = { + PartNumber: number, + LastModified: any, // {Date} Time when a part is uploaded. + ETag: string, + size: number +} + +export type Upload = { + name: string, + uploadId: string, + initiated: any +} + // parameters type export type ListBucketsQueryType = { prefix?: string, // search buckets using prefix key @@ -246,6 +268,89 @@ export type UploadPartResult = { res: NormalSuccessResponse } +export type CompleteMultipartUploadOptions = { + timeout?: number, + callback?: ObjectCallback, + headers?: object +} + +export type CompleteMultipartUploadResult = { + bucket: string, + name: string, + etag: string, + data: object, + res: NormalSuccessResponse +} + +export type MultipartUploadOptions = { + parallel?: number, // the number of parts to be uploaded in parallel + partSize?: number, // the suggested size for each part + progress?: Function, // the progress callback called after each successful upload of one part, it will be given three parameters: (percentage {Number}, checkpoint {Object}, res {Object}) + checkpoint?: Checkpoint, // the checkpoint to resume upload, if this is provided, it will continue the upload from where interrupted, otherwise a new multipart upload will be created. + meta?: UserMeta, + mime?: string, + callback?: ObjectCallback, + headers?: object, + timeout?: number + copyheaders?: object, // {Object} only uploadPartCopy api used, detail +} + +export type MultipartUploadResult = { + bucket: string, + name: string, + etag: string, + data: object, + res: NormalSuccessResponse +} + +export type MultipartUploadCopyResult = { + bucket: string, + name: string, + etag: string, + res: NormalSuccessResponse +} + +export type MultipartUploadCopySourceData = { + sourceKey: string, // the source object name + sourceBucketName: string, // sourceData. the source bucket name + startOffset: number, // data copy start byte offset, e.g: 0 + endOffset: number // data copy end byte offset, e.g: 102400 +} + +export type ListPartsQuery = { + 'max-parts': number, // The maximum part number in the response of the OSS. default value: 1000. + 'part-number-marker': number, // Starting position of a specific list. A part is listed only when the part number is greater than the value of this parameter. + 'encoding-type': string // Specify the encoding of the returned content and the encoding type. Optional value: url +} + +export type ListPartsResult = { + uploadId: string, + bucket: string, + name: string, + PartNumberMarker: number, + nextPartNumberMarker: number, + maxParts: number, + isTruncated: boolean, + parts: Array, + res: NormalSuccessResponse +} + +export type ListUploadsQuery = { + prefix?: string, + 'max-uploads'?: number, + 'key-marker'?: string, + 'upload-id-marker'?: string +} + +export type ListUploadsResult = { + res: NormalSuccessResponse, + bucket: string, + nextKeyMarker: any, + nextUploadIdMarker: any, + isTruncated: boolean, + uploads: Array +} + export default class OSS { // the image client static ImageClient: any @@ -623,4 +728,64 @@ export default class OSS { */ uploadPartCopy(name: string, uploadId: string, partNo: number, range: string, sourceData: { sourceKey: string, sourceBucketName: string }, options: { timeout?: number, headers?: object }): Promise + /** + * After uploading all data parts, you must call the Complete Multipart Upload API to complete Multipart Upload for the entire file. + * @param {string} name + * @param {string} uploadId + * @param {Array<{number: number; etag: string}>} parts + * @param {CompleteMultipartUploadOptions} options + * @return {Promise} + */ + completeMultipartUpload(name: string, uploadId: string, parts: Array<{ number: number, etag: string }>, options?:CompleteMultipartUploadOptions): Promise + + /** + * Upload file with OSS multipart. + * this function contains initMultipartUpload, uploadPart, completeMultipartUpload. When you use multipartUpload api，if you encounter problems with ConnectionTimeoutError, you should handle ConnectionTimeoutError in your business code. + * How to resolve ConnectionTimeoutError, you can decrease partSize size 、 Increase timeout 、Retry request , or give tips in your business code; + * @param {string} name + * @param file + * @param {MultipartUploadOptions} options + * @return {Promise} + */ + multipartUpload(name: string, file: any, options: MultipartUploadOptions): Promise + + /** + * Copy file with OSS multipart. + * this function contains head, initMultipartUpload, uploadPartCopy, completeMultipartUpload. + * When copying a file larger than 1 GB, you should use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object. + * @param {string} name + * @param {MultipartUploadCopySourceData} sourceData + * @param {MultipartUploadOptions} options + * @return {Promise} + */ + multipartUploadCopy(name: string, sourceData: MultipartUploadCopySourceData, options?: MultipartUploadOptions): Promise + + /** + * The ListParts command can be used to list all successfully uploaded parts mapped to a specific upload ID, i.e.: those not completed and not aborted. + * @param {string} name + * @param {string} uploadId + * @param {ListPartsQuery} query + * @param {RequestOptions} options + * @return {Promise} + */ + listParts(name: string, uploadId: string, query?: ListPartsQuery, options?: RequestOptions): Promise + + /** + * List on-going multipart uploads, i.e.: those not completed and not aborted. + * @param {ListUploadsQuery} query + * @param {RequestOptions} options + * @return {Promise} + */ + listUploads(query: ListUploadsQuery, options?: RequestOptions): Promise + + /** + * Abort a multipart upload for object. + * @param {string} name + * @param {string} uploadId + * @param {RequestOptions} options + * @return {Promise} + */ + abortMultipartUpload(name: string, uploadId: string, options?: RequestOptions): Promise + + /************************************************ RTMP Operations *************************************************************/ } From eea11d19fe8fb925d07ef1fd4ed19308a2b43ffc Mon Sep 17 00:00:00 2001 From: ptrdu Date: Thu, 27 Sep 2018 16:30:04 +0800 Subject: [PATCH 005/799] FEATURE: add rtmp operations definition --- types/ali-oss/ali-oss-tests.ts | 8 +- types/ali-oss/index.d.ts | 257 ++++++++++++++++++++++++++------- 2 files changed, 213 insertions(+), 52 deletions(-) diff --git a/types/ali-oss/ali-oss-tests.ts b/types/ali-oss/ali-oss-tests.ts index 3cf3229da9..82941c1e5e 100644 --- a/types/ali-oss/ali-oss-tests.ts +++ b/types/ali-oss/ali-oss-tests.ts @@ -1,3 +1,9 @@ import OSS from "ali-oss"; -const client = new OSS(); +const client = new OSS({ + accessKeyId: 'your access key', + accessKeySecret: 'your access secret', + bucket: 'your bucket name', + region: 'oss-cn-hangzhou' +}); + diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index fc0ff41ae1..9f5530db71 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -6,7 +6,19 @@ // general type -export type Bucket = { +export interface Options { + accessKeyId: string, // access secret you create + accessKeySecret: string, // access secret you create + stsToken?: string, // used by temporary authorization + bucket?: string, // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. + endpoint?: string, // oss region domain. It takes priority over region. + region?: string, // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou. + internal?: boolean, // access OSS with aliyun internal network or not, default is false. If your servers are running on aliyun too, you can set true to save lot of money. + secure?: boolean, // instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol. + timeout?: string | number // instance level timeout for all operations, default is 60s +} + +export type Bucket = { } @@ -16,14 +28,14 @@ export type ACLType = "public-read-write" | "public-read" | "and private" export type HTTPMethods = "GET" | "POST" | "DELETE" | "PUT"; -export type RequestOptions = { +export interface RequestOptions { // the operation timeout timeout?: number } export type RuleStatusType = "Enabled" | "Disabled" -export type LifecycleRule = { +export interface LifecycleRule { id?: string, // rule id, if not set, OSS will auto create it with random string. prefix: string, // store prefix status: RuleStatusType, // rule status, allow values: Enabled or Disabled @@ -31,7 +43,7 @@ export type LifecycleRule = { date: string // expire date, e.g.: 2022-10-11T00:00:00.000Z date and days only set one. } -export type CORSRule = { +export interface CORSRule { allowedOrigin: string | Array, // configure for Access-Control-Allow-Origin header allowedMethod: string | Array, // configure for Access-Control-Allow-Methods header allowedHeader?: string | Array, // configure for Access-Control-Allow-Headers header @@ -39,12 +51,12 @@ export type CORSRule = { maxAgeSeconds?: string | Array, // configure for Access-Control-Max-Age header } -export type OwnerType = { +export interface OwnerType { id: string, displayName: string } -export type ObjectMeta = { +export interface ObjectMeta { name: string, // object name on oss lastModified: string, // object last modified GMT date, e.g.: 2015-02-19T08:39:44.000Z etag: string, // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" @@ -54,7 +66,7 @@ export type ObjectMeta = { owner: OwnerType, } -export type NormalSuccessResponse = { +export interface NormalSuccessResponse { //response status status: number, // response headers @@ -65,12 +77,12 @@ export type NormalSuccessResponse = { rt: number } -export type UserMeta = { +export interface UserMeta { uid: number, pid: number } -export type ObjectCallback = { +export interface ObjectCallback { url: string, // After a file is uploaded successfully, the OSS sends a callback request to this URL. host?: string, // The host header value for initiating callback requests. body: string, // The value of the request body when a callback is initiated, for example, key=$(key)&etag=$(etag)&my_var=$(x:my_var). @@ -79,12 +91,12 @@ export type ObjectCallback = { headers?: object // extra headers, detail see RFC 2616 } -export type ModifyData = { +export interface ModifyData { lastModified: string, // object last modified GMT string etag: string // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" } -export type Checkpoint = { +export interface Checkpoint { file: any, // The file object selected by the user, if the browser is restarted, it needs the user to manually trigger the settings name: string, // object key fileSize: number, @@ -93,44 +105,58 @@ export type Checkpoint = { doneParts: Array<{ number: number, etag: string }> } -export type ObjectPart = { +export interface ObjectPart { PartNumber: number, LastModified: any, // {Date} Time when a part is uploaded. ETag: string, size: number } -export type Upload = { +export interface Upload { name: string, uploadId: string, initiated: any } +export interface Channel { + Name: string, + Description: string, + Status: string, + LastModified: string, + PublishUrls: Array, + PlayUrls: Array +} + +export interface ChannelHistory { + StartTime: string, // + EndTime: string, + RemoteAddr: string // the remote addr +} // parameters type -export type ListBucketsQueryType = { +export interface ListBucketsQueryType { prefix?: string, // search buckets using prefix key marker?: string, // search start from marker, including marker key 'max-keys'?: string | number // max buckets, default is 100, limit to 1000 } -export type PutBucketOptions = { +export interface PutBucketOptions { timeout: number, storageClass: StorageType } -export type PutBucketWebsiteConfig = { +export interface PutBucketWebsiteConfig { index: string, // default page, e.g.: index.html error?: string // error page, e.g.: 'error.html' } -export type ListObjectsQuery = { +export interface ListObjectsQuery { prefix?: string, // search object using prefix key marker?: string, // search start from marker, including marker key delimiter?: string, // delimiter search scope e.g. / only search current dir, not including subdir 'max-keys': string | number // max objects, default is 100, limit to 1000 } -export type ListObjectResult = { +export interface ListObjectResult { objects: Array, prefixes: Array, isTruncated: boolean, @@ -138,20 +164,20 @@ export type ListObjectResult = { res: NormalSuccessResponse } -export type PutObjectOptions = { +export interface PutObjectOptions { timeout?: number, // the operation timeout mime?: string, // custom mime, will send with Content-Type entity header meta?: UserMeta, // user meta, will send with x-oss-meta- prefix string e.g.: { uid: 123, pid: 110 } callback: ObjectCallback, } -export type PutObjectResult = { +export interface PutObjectResult { name: string, data: object, res: NormalSuccessResponse } -export type PutStreamOptions = { +export interface PutStreamOptions { contentLength?: number, // the stream length, chunked encoding will be used if absent timeout: number, // the operation timeout mime: string, // custom mime, will send with Content-Type entity header @@ -159,7 +185,7 @@ export type PutStreamOptions = { callback: ObjectCallback } -export type AppendObjectOptions = { +export interface AppendObjectOptions { position?: string, // specify the position which is the content length of the latest object timeout?: number, // the operation timeout mime?: string, // custom mime, will send with Content-Type entity header @@ -167,74 +193,74 @@ export type AppendObjectOptions = { headers?: object } -export type AppendObjectResult = { +export interface AppendObjectResult { name: string, url: string, // the url of oss res: NormalSuccessResponse, nextAppendPosition: string, // the next position } -export type HeadObjectOptions = { +export interface HeadObjectOptions { timeout?: number, headers?: object } -export type HeadObjectResult = { +export interface HeadObjectResult { status: number, // response status, maybe 200 or 304 meta: UserMeta, res: NormalSuccessResponse } -export type GetObjectOptions = { +export interface GetObjectOptions { timeout?: number, process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} headers?: object } -export type GetObjectResult = { +export interface GetObjectResult { content?: any, // file content buffer if file parameter is null or ignore res: NormalSuccessResponse } -export type GetStreamOptions = { +export interface GetStreamOptions { timeout?: number, process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} headers?: object } -export type GetStreamResult = { +export interface GetStreamResult { stream?: any, // readable stream instance if response status is not 200, stream will be null. res: NormalSuccessResponse } -export type CopyObjectOptions = { +export interface CopyObjectOptions { timeout?: number, meta?: UserMeta, headers?: object } -export type CopyAndPutMetaResult = { +export interface CopyAndPutMetaResult { data: ModifyData, res: NormalSuccessResponse } -export type DeleteMultiOptions = { +export interface DeleteMultiOptions { quite?: boolean // quiet mode or verbose mode, default is false, verbose mode quiet mode: if all objects delete succes, return emtpy response. otherwise return delete error object results. verbose mode: return all object delete results. timeout?: number } -export type DeleteMultiResult = { +export interface DeleteMultiResult { deleted?: Array // deleted object names list res: NormalSuccessResponse } -export type ResponseHeaderType = { +export interface ResponseHeaderType { 'content-type'?: string, 'content-disposition'? :string, 'cache-control'?: string } -export type SignatureUrlOptions = { +export interface SignatureUrlOptions { expires?: number, // after expires seconds, the url will become invalid, default is 1800 method?: HTTPMethods, // the HTTP method, default is 'GET' 'Content-Type'?: string, // set the request content type @@ -243,38 +269,38 @@ export type SignatureUrlOptions = { callback?: ObjectCallback } -export type GetACLResult = { +export interface GetACLResult { acl: ACLType, res: NormalSuccessResponse } -export type InitMultipartUploadOptions = { +export interface InitMultipartUploadOptions { timeout?: number, mime?: string, // Mime file type meta?: UserMeta, headers?: object } -export type InitMultipartUploadResult = { +export interface InitMultipartUploadResult { res: { status: number, headers: object, size: number, rt: number } bucket: string, // bucket name name: string, // object name store on OSS uploadId: string, // upload id, use for uploadPart, completeMultipart } -export type UploadPartResult = { +export interface UploadPartResult { name: string, etag: string, res: NormalSuccessResponse } -export type CompleteMultipartUploadOptions = { +export interface CompleteMultipartUploadOptions { timeout?: number, callback?: ObjectCallback, headers?: object } -export type CompleteMultipartUploadResult = { +export interface CompleteMultipartUploadResult { bucket: string, name: string, etag: string, @@ -282,7 +308,7 @@ export type CompleteMultipartUploadResult = { res: NormalSuccessResponse } -export type MultipartUploadOptions = { +export interface MultipartUploadOptions { parallel?: number, // the number of parts to be uploaded in parallel partSize?: number, // the suggested size for each part progress?: Function, // the progress callback called after each successful upload of one part, it will be given three parameters: (percentage {Number}, checkpoint {Object}, res {Object}) @@ -295,7 +321,7 @@ export type MultipartUploadOptions = { copyheaders?: object, // {Object} only uploadPartCopy api used, detail } -export type MultipartUploadResult = { +export interface MultipartUploadResult { bucket: string, name: string, etag: string, @@ -303,27 +329,27 @@ export type MultipartUploadResult = { res: NormalSuccessResponse } -export type MultipartUploadCopyResult = { +export interface MultipartUploadCopyResult { bucket: string, name: string, etag: string, res: NormalSuccessResponse } -export type MultipartUploadCopySourceData = { +export interface MultipartUploadCopySourceData { sourceKey: string, // the source object name sourceBucketName: string, // sourceData. the source bucket name startOffset: number, // data copy start byte offset, e.g: 0 endOffset: number // data copy end byte offset, e.g: 102400 } -export type ListPartsQuery = { +export interface ListPartsQuery { 'max-parts': number, // The maximum part number in the response of the OSS. default value: 1000. 'part-number-marker': number, // Starting position of a specific list. A part is listed only when the part number is greater than the value of this parameter. 'encoding-type': string // Specify the encoding of the returned content and the encoding type. Optional value: url } -export type ListPartsResult = { +export interface ListPartsResult { uploadId: string, bucket: string, name: string, @@ -335,14 +361,14 @@ export type ListPartsResult = { res: NormalSuccessResponse } -export type ListUploadsQuery = { +export interface ListUploadsQuery { prefix?: string, 'max-uploads'?: number, 'key-marker'?: string, 'upload-id-marker'?: string } -export type ListUploadsResult = { +export interface ListUploadsResult { res: NormalSuccessResponse, bucket: string, nextKeyMarker: any, @@ -351,9 +377,62 @@ export type ListUploadsResult = { uploads: Array } +export interface PutChannelConf { + Description?: string, + Status?: string, + Target?: { + Type: string, + FragDuration: number, + FragCount: number, + PlaylistName: string + } +} + +export interface PutChannelResult { + publishUrls: Array, + playUrls: Array, + res: NormalSuccessResponse +} + +export interface GetChannelResult { + Status: string, + ConnectedTime?: string, + RemoteAddr?: string, + Video?: object, + Audio?: object, + res: NormalSuccessResponse +} + +export interface ListChannelsQuery { + prefix: string, // the channel id prefix (returns channels with this prefix) + marker: string, // the channle id marker (returns channels after this id) + 'max-keys ': number // max number of channels to return +} + +export interface ListChannelsResult { + channels: Array + nextMarker: string | null, + isTruncated: boolean, + res: NormalSuccessResponse +} + +export interface ChannelHistoryResult { + records: ChannelHistory, + res: NormalSuccessResponse +} + +export interface GetRtmpUrlOptions { + expires?: number, // the expire time in seconds of the url + params?: object, // the additional paramters for url, e.g.: {playlistName: 'play.m3u8'} + timeout?: number // the operation timeout +} + export default class OSS { // the image client static ImageClient: any + + constructor(options: Options) + /******************************************* the bucket operations *************************************************/ // base operators @@ -683,7 +762,7 @@ export default class OSS { * @param {RequestOptions} options * @return {Promise} */ - getACL(name:string, options?: RequestOptions): Promise + getACL(name: string, options?: RequestOptions): Promise /** * Restore Object. @@ -736,7 +815,7 @@ export default class OSS { * @param {CompleteMultipartUploadOptions} options * @return {Promise} */ - completeMultipartUpload(name: string, uploadId: string, parts: Array<{ number: number, etag: string }>, options?:CompleteMultipartUploadOptions): Promise + completeMultipartUpload(name: string, uploadId: string, parts: Array<{ number: number, etag: string }>, options?: CompleteMultipartUploadOptions): Promise /** * Upload file with OSS multipart. @@ -788,4 +867,80 @@ export default class OSS { abortMultipartUpload(name: string, uploadId: string, options?: RequestOptions): Promise /************************************************ RTMP Operations *************************************************************/ + /** + * Create a live channel. + * @param {string} id + * @param {PutChannelConf} conf + * @param {RequestOptions} options + * @return {Promise} + */ + putChannel(id: string, conf: PutChannelConf, options?: RequestOptions): Promise + + /** + * Get live channel info. + * @param {string} id + * @param {RequestOptions} options + * @return {Promise<{data: PutChannelConf; res: NormalSuccessResponse}>} + */ + getChannel(id: string, options?: RequestOptions): Promise<{ data: PutChannelConf, res: NormalSuccessResponse }> + + /** + * Delete a live channel. + * @param {string} id + * @param {RequestOptions} options + * @return {Promise} + */ + deleteChannel(id: string, options?: RequestOptions): Promise + + /** + * Change the live channel status. + * @param {string} id + * @param {string} status + * @param {RequestOptions} options + * @return {Promise} + */ + putChannelStatus(id: string, status?: string, options?: RequestOptions): Promise + + /** + * Get the live channel status. + * @param {string} id + * @param {RequestOptions} options + * @return {Promise} + */ + getChannelStatus(id: string, options?: RequestOptions): Promise + + /** + * List channels. + * @param {ListChannelsQuery} query + * @param {RequestOptions} options + * @return {Promise} + */ + listChannels(query: ListChannelsQuery, options?: RequestOptions): Promise + + /** + * Get the live channel history. + * @param {string} id + * @param {RequestOptions} options + * @return {Promise} + */ + getChannelHistory(id: string, options?: RequestOptions): Promise + + /** + * Create a VOD playlist for the channel. + * @param {string} id + * @param {string} name + * @param {{startTime: number; endTime: number}} time + * @param {RequestOptions} options + * @return {Promise} + */ + createVod(id: string, name: string, time: { startTime: number, endTime: number }, options?: RequestOptions): Promise + + /** + * Get signatured rtmp url for publishing. + * @param {string} channelId + * @param {GetRtmpUrlOptions} options + * @return {string} + */ + getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string } + From 8c7758f7efe942e0f68ffa3a769e67b1b06b8e30 Mon Sep 17 00:00:00 2001 From: ptrdu Date: Sat, 29 Sep 2018 15:50:26 +0800 Subject: [PATCH 006/799] FEAT: add ImageClient and cluster --- types/ali-oss/Cluster.d.ts | 64 ++++++++++++++++++++++ types/ali-oss/ImageClient.d.ts | 99 ++++++++++++++++++++++++++++++++++ types/ali-oss/ali-oss-tests.ts | 9 ++++ types/ali-oss/index.d.ts | 11 +++- types/ali-oss/tsconfig.json | 2 + 5 files changed, 184 insertions(+), 1 deletion(-) create mode 100644 types/ali-oss/Cluster.d.ts create mode 100644 types/ali-oss/ImageClient.d.ts diff --git a/types/ali-oss/Cluster.d.ts b/types/ali-oss/Cluster.d.ts new file mode 100644 index 0000000000..57ab35719b --- /dev/null +++ b/types/ali-oss/Cluster.d.ts @@ -0,0 +1,64 @@ +import { + ACLType, + CopyAndPutMetaResult, + CopyObjectOptions, + DeleteMultiOptions, + DeleteMultiResult, + GetObjectOptions, + GetObjectResult, + GetStreamOptions, + GetStreamResult, + HeadObjectOptions, + HeadObjectResult, + ListObjectResult, + ListObjectsQuery, + NormalSuccessResponse, + PutObjectOptions, + PutObjectResult, + PutStreamOptions, + RequestOptions, + SignatureUrlOptions, + UserMeta +} from "./index"; + +export interface ClusterType { + host: string, + accessKeyId: string, + accessKeySecret: string +} + +export interface ClusterOptions { + clusters: Array, + schedule?: string +} + + +export class Cluster { + constructor(options: ClusterOptions) + + list(query: ListObjectsQuery | null, options: RequestOptions): Promise + + put(name: string, file: any, options?: PutObjectOptions): Promise + + putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }> + + head(name: string, options?: HeadObjectOptions): Promise + + get(name: string, file?: any, options?: GetObjectOptions): Promise + + getStream(name?: string, options?: GetStreamOptions): Promise + + delete(name: string, options?: RequestOptions): Promise + + copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise + + putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise + + deleteMulti(names: Array, options?: DeleteMultiOptions): Promise + + signatureUrl(name: string, options?: SignatureUrlOptions): string + + putACL(name: string, acl: ACLType, options?: RequestOptions): Promise + + restore(name: string, options?: RequestOptions): Promise +} diff --git a/types/ali-oss/ImageClient.d.ts b/types/ali-oss/ImageClient.d.ts new file mode 100644 index 0000000000..ec6ec9b71a --- /dev/null +++ b/types/ali-oss/ImageClient.d.ts @@ -0,0 +1,99 @@ +import {NormalSuccessResponse, RequestOptions} from "./index"; + +export interface Options { + imageHost: string, // your image service domain that binding to a OSS bucket + accessKeyId: string, // access key you create on aliyun console website + accessKeySecret: string, // access secret you create + bucket: string, // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. + region?: string, // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou Current available: oss-cn-hangzhou, oss-cn-qingdao, oss-cn-beijing, oss-cn-hongkong and oss-cn-shenzhen + internal?: boolean, // access OSS with aliyun internal network or not, default is false If your servers are running on aliyun too, you can set true to save lot of money. + timeout?: string | number, // instance level timeout for all operations, default is 60s +} + +export interface ImageGetOptions { + timeout?: number, + headers?: object +} + +export interface StyleData { + Name: string, // style name + Content: string, // style content + CreateTime: string, // style create time + LastModifyTime: string // style last modify time +} +export class Client { + constructor(options: Options) + + /** + * Get an image from the image channel. + * @param {string} name + * @param file - String|WriteStream} file path or WriteStream instance to store the image If file is null or ignore this parameter, function will return info contains content property. + * @param {ImageGetOptions} options + * @return {Promise<{content: any; res: NormalSuccessResponse}>} + */ + get(name: string, file?: any, options?: ImageGetOptions): Promise<{ content: any, res: NormalSuccessResponse }> + + /** + * Get an image read stream. + * @param {string} name + * @param {ImageGetOptions} options + * @return {Promise<{stream: any; res: NormalSuccessResponse}>} + */ + getStream(name: string, options?: ImageGetOptions): Promise<{ stream: any, res: NormalSuccessResponse }> + + /** + * Get a image exif info by image object name from the image channel. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise<{data: object; res: NormalSuccessResponse}>} + */ + getExif(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + + /** + * Get a image info and exif info by image object name from the image channel. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise<{data: object; res: NormalSuccessResponse}>} + */ + getInfo(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + + /** + * todo + * @param {string} name + * @param {string} style + * @param {RequestOptions} options + * @return {Promise<{data: object; res: NormalSuccessResponse}>} + */ + putStyle(name: string, style: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + + /** + * Get a style by name from the image channel. + * @param {string} name + * @param {RequestOptions} options + * @return {Promise<{data: StyleData; res: NormalSuccessResponse}>} + */ + getStyle(name: string, options?: RequestOptions): Promise<{ data: StyleData, res: NormalSuccessResponse}> + + /** + * Get all styles from the image channel. + * @param {RequestOptions} options + * @return {Promise>} + */ + listStyle(options?: RequestOptions): Promise> + + /** + * todo + * @param {string} styleName + * @param {RequestOptions} options + * @return {Promise} + */ + deleteStyle(styleName: string, options?: RequestOptions): Promise + + /** + * Create a signature url for directly download. + * @param {string} name + * @param {{expires?: string; timeout?: string}} options + * @return {string} + */ + signatureUrl(name: string, options?: { expires?: string, timeout?: string }): string +} diff --git a/types/ali-oss/ali-oss-tests.ts b/types/ali-oss/ali-oss-tests.ts index 82941c1e5e..e441e15577 100644 --- a/types/ali-oss/ali-oss-tests.ts +++ b/types/ali-oss/ali-oss-tests.ts @@ -7,3 +7,12 @@ const client = new OSS({ region: 'oss-cn-hangzhou' }); +const ImageClient = OSS.ImageClient({ + imageHost: 'xxxx', + accessKeySecret: "xxxx", + accessKeyId: 'xxxxxx', + bucket: "", + internal: false, + region: "", + timeout: undefined +}) diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index 9f5530db71..1ced1efaf8 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -6,6 +6,9 @@ // general type +import * as ImageClientDefinition from './ImageClient' +import * as ClusterDefinition from "./Cluster" + export interface Options { accessKeyId: string, // access secret you create accessKeySecret: string, // access secret you create @@ -427,9 +430,14 @@ export interface GetRtmpUrlOptions { timeout?: number // the operation timeout } +export interface ObjectInterface { + +} + export default class OSS { // the image client - static ImageClient: any + public static ImageClient: (options: ImageClientDefinition.Options) => ImageClientDefinition.Client + public static Cluster: (options: ClusterDefinition.ClusterOptions) => ClusterDefinition.Cluster constructor(options: Options) @@ -942,5 +950,6 @@ export default class OSS { * @return {string} */ getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string + } diff --git a/types/ali-oss/tsconfig.json b/types/ali-oss/tsconfig.json index a3e68ada2b..b6f46ae8e8 100644 --- a/types/ali-oss/tsconfig.json +++ b/types/ali-oss/tsconfig.json @@ -18,6 +18,8 @@ }, "files": [ "index.d.ts", + "ImageClient.d.ts", + "Cluster.d.ts", "ali-oss-tests.ts" ] } From c56edf64cc154e9aa4d7efad94f7aa01ee1b585c Mon Sep 17 00:00:00 2001 From: ptrdu Date: Sat, 29 Sep 2018 17:49:53 +0800 Subject: [PATCH 007/799] FEAT: add test --- types/ali-oss/ImageClient.d.ts | 8 ++++---- types/ali-oss/ali-oss-tests.ts | 27 ++++++++++++++++++++++----- types/ali-oss/index.d.ts | 19 +++++++++++-------- 3 files changed, 37 insertions(+), 17 deletions(-) diff --git a/types/ali-oss/ImageClient.d.ts b/types/ali-oss/ImageClient.d.ts index ec6ec9b71a..047077904f 100644 --- a/types/ali-oss/ImageClient.d.ts +++ b/types/ali-oss/ImageClient.d.ts @@ -1,6 +1,6 @@ -import {NormalSuccessResponse, RequestOptions} from "./index"; +import { NormalSuccessResponse, RequestOptions } from "./index"; -export interface Options { +export interface ImageClientOptions { imageHost: string, // your image service domain that binding to a OSS bucket accessKeyId: string, // access key you create on aliyun console website accessKeySecret: string, // access secret you create @@ -21,8 +21,8 @@ export interface StyleData { CreateTime: string, // style create time LastModifyTime: string // style last modify time } -export class Client { - constructor(options: Options) +export class ImageClient { + constructor(options: ImageClientOptions) /** * Get an image from the image channel. diff --git a/types/ali-oss/ali-oss-tests.ts b/types/ali-oss/ali-oss-tests.ts index e441e15577..a9c39ab199 100644 --- a/types/ali-oss/ali-oss-tests.ts +++ b/types/ali-oss/ali-oss-tests.ts @@ -5,14 +5,31 @@ const client = new OSS({ accessKeySecret: 'your access secret', bucket: 'your bucket name', region: 'oss-cn-hangzhou' -}); +}) + const ImageClient = OSS.ImageClient({ - imageHost: 'xxxx', - accessKeySecret: "xxxx", - accessKeyId: 'xxxxxx', + imageHost: 'host', + accessKeySecret: "secret", + accessKeyId: 'id', bucket: "", internal: false, region: "", - timeout: undefined + timeout: 2000 +}) + +const cluster = OSS.Cluster({ + clusters: [ + { + accessKeyId: 'id', + accessKeySecret: 'secret', + host: "" + }, + { + accessKeyId: 'id', + accessKeySecret: 'secret', + host: "" + }, + ], + schedule: 'masterSlave', }) diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index 1ced1efaf8..0f17bbb142 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -8,6 +8,10 @@ import * as ImageClientDefinition from './ImageClient' import * as ClusterDefinition from "./Cluster" +import {ImageClient} from "./ImageClient"; + +export * from './ImageClient' +export * from './Cluster' export interface Options { accessKeyId: string, // access secret you create @@ -22,7 +26,10 @@ export interface Options { } export type Bucket = { - + name: string, + region: string, + creationDate: string, + StorageClass: StorageType } export type StorageType = "Standard" | "IA" | "Archive" @@ -430,13 +437,9 @@ export interface GetRtmpUrlOptions { timeout?: number // the operation timeout } -export interface ObjectInterface { - -} - export default class OSS { // the image client - public static ImageClient: (options: ImageClientDefinition.Options) => ImageClientDefinition.Client + public static ImageClient: (options: ImageClientDefinition.ImageClientOptions) => ImageClientDefinition.ImageClient public static Cluster: (options: ClusterDefinition.ClusterOptions) => ClusterDefinition.Cluster constructor(options: Options) @@ -455,7 +458,8 @@ export default class OSS { /** * Create a new bucket. - * @param {string} name - bucket name If bucket exists and not belong to current account, will throw BucketAlreadyExistsError. If bucket not exists, will create a new bucket and set it's ACL. + * @param {string} name - bucket name If bucket exists and not belong to current account, will throw BucketAlreadyExistsError. + * If bucket not exists, will create a new bucket and set it's ACL. * @param {PutBucketOptions} options - optional parameters * @return { Promise<{ bucket: string, res: NormalSuccessResponse }> } */ @@ -952,4 +956,3 @@ export default class OSS { getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string } - From 14dda1b33703537649a2e5f019d1de0c74a9148b Mon Sep 17 00:00:00 2001 From: ptrdu Date: Sat, 29 Sep 2018 18:50:18 +0800 Subject: [PATCH 008/799] FIX: fix some used import and the typescript version --- types/ali-oss/index.d.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index 0f17bbb142..b7eba95d62 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -2,13 +2,10 @@ // Project: https://github.com/ali-sdk/ali-oss // Definitions by: Ptrdu // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 3.2.0 - -// general type +// TypeScript Version: 2.3 import * as ImageClientDefinition from './ImageClient' import * as ClusterDefinition from "./Cluster" -import {ImageClient} from "./ImageClient"; export * from './ImageClient' export * from './Cluster' From 83d5d18ae729119b39a63f5c6ed3d698507fc48d Mon Sep 17 00:00:00 2001 From: ptrdu Date: Sun, 30 Sep 2018 10:17:52 +0800 Subject: [PATCH 009/799] FIX: fix the tsconfig and tslint error --- types/ali-oss/Cluster.d.ts | 37 +- types/ali-oss/ImageClient.d.ts | 72 +-- types/ali-oss/ali-oss-tests.ts | 7 +- types/ali-oss/index.d.ts | 823 +++++++++++++-------------------- types/ali-oss/tsconfig.json | 2 +- types/ali-oss/tslint.json | 78 +--- 6 files changed, 359 insertions(+), 660 deletions(-) diff --git a/types/ali-oss/Cluster.d.ts b/types/ali-oss/Cluster.d.ts index 57ab35719b..60886fca36 100644 --- a/types/ali-oss/Cluster.d.ts +++ b/types/ali-oss/Cluster.d.ts @@ -22,43 +22,42 @@ import { } from "./index"; export interface ClusterType { - host: string, - accessKeyId: string, - accessKeySecret: string + host: string; + accessKeyId: string; + accessKeySecret: string; } export interface ClusterOptions { - clusters: Array, - schedule?: string + clusters: ClusterType[]; + schedule?: string; } - export class Cluster { constructor(options: ClusterOptions) - list(query: ListObjectsQuery | null, options: RequestOptions): Promise + list(query: ListObjectsQuery | null, options: RequestOptions): Promise; - put(name: string, file: any, options?: PutObjectOptions): Promise + put(name: string, file: any, options?: PutObjectOptions): Promise; - putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }> + putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }>; - head(name: string, options?: HeadObjectOptions): Promise + head(name: string, options?: HeadObjectOptions): Promise; - get(name: string, file?: any, options?: GetObjectOptions): Promise + get(name: string, file?: any, options?: GetObjectOptions): Promise; - getStream(name?: string, options?: GetStreamOptions): Promise + getStream(name?: string, options?: GetStreamOptions): Promise; - delete(name: string, options?: RequestOptions): Promise + delete(name: string, options?: RequestOptions): Promise; - copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise + copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise; - putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise + putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise; - deleteMulti(names: Array, options?: DeleteMultiOptions): Promise + deleteMulti(names: string[], options?: DeleteMultiOptions): Promise; - signatureUrl(name: string, options?: SignatureUrlOptions): string + signatureUrl(name: string, options?: SignatureUrlOptions): string; - putACL(name: string, acl: ACLType, options?: RequestOptions): Promise + putACL(name: string, acl: ACLType, options?: RequestOptions): Promise; - restore(name: string, options?: RequestOptions): Promise + restore(name: string, options?: RequestOptions): Promise; } diff --git a/types/ali-oss/ImageClient.d.ts b/types/ali-oss/ImageClient.d.ts index 047077904f..850213083c 100644 --- a/types/ali-oss/ImageClient.d.ts +++ b/types/ali-oss/ImageClient.d.ts @@ -1,99 +1,71 @@ import { NormalSuccessResponse, RequestOptions } from "./index"; export interface ImageClientOptions { - imageHost: string, // your image service domain that binding to a OSS bucket - accessKeyId: string, // access key you create on aliyun console website - accessKeySecret: string, // access secret you create - bucket: string, // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. - region?: string, // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou Current available: oss-cn-hangzhou, oss-cn-qingdao, oss-cn-beijing, oss-cn-hongkong and oss-cn-shenzhen - internal?: boolean, // access OSS with aliyun internal network or not, default is false If your servers are running on aliyun too, you can set true to save lot of money. - timeout?: string | number, // instance level timeout for all operations, default is 60s + imageHost: string; // your image service domain that binding to a OSS bucket + accessKeyId: string; // access key you create on aliyun console website + accessKeySecret: string; // access secret you create + bucket: string; // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. + region?: string; // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou + internal?: boolean; // access OSS with aliyun internal network or not, default is false If your servers are running on aliyun too, you can set true to save lot of money. + timeout?: string | number; // instance level timeout for all operations, default is 60s } export interface ImageGetOptions { - timeout?: number, - headers?: object + timeout?: number; + headers?: object; } export interface StyleData { - Name: string, // style name - Content: string, // style content - CreateTime: string, // style create time - LastModifyTime: string // style last modify time + Name: string; // style name + Content: string; // style content + CreateTime: string; // style create time + LastModifyTime: string; // style last modify time } export class ImageClient { constructor(options: ImageClientOptions) /** * Get an image from the image channel. - * @param {string} name - * @param file - String|WriteStream} file path or WriteStream instance to store the image If file is null or ignore this parameter, function will return info contains content property. - * @param {ImageGetOptions} options - * @return {Promise<{content: any; res: NormalSuccessResponse}>} */ - get(name: string, file?: any, options?: ImageGetOptions): Promise<{ content: any, res: NormalSuccessResponse }> + get(name: string, file?: any, options?: ImageGetOptions): Promise<{ content: any, res: NormalSuccessResponse }>; /** * Get an image read stream. - * @param {string} name - * @param {ImageGetOptions} options - * @return {Promise<{stream: any; res: NormalSuccessResponse}>} */ - getStream(name: string, options?: ImageGetOptions): Promise<{ stream: any, res: NormalSuccessResponse }> + getStream(name: string, options?: ImageGetOptions): Promise<{ stream: any, res: NormalSuccessResponse }>; /** * Get a image exif info by image object name from the image channel. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise<{data: object; res: NormalSuccessResponse}>} */ - getExif(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + getExif(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }>; /** * Get a image info and exif info by image object name from the image channel. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise<{data: object; res: NormalSuccessResponse}>} */ - getInfo(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + getInfo(name: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }>; /** * todo - * @param {string} name - * @param {string} style - * @param {RequestOptions} options - * @return {Promise<{data: object; res: NormalSuccessResponse}>} */ - putStyle(name: string, style: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }> + putStyle(name: string, style: string, options?: RequestOptions): Promise<{ data: object, res: NormalSuccessResponse }>; /** * Get a style by name from the image channel. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise<{data: StyleData; res: NormalSuccessResponse}>} */ - getStyle(name: string, options?: RequestOptions): Promise<{ data: StyleData, res: NormalSuccessResponse}> + getStyle(name: string, options?: RequestOptions): Promise<{ data: StyleData, res: NormalSuccessResponse}>; /** * Get all styles from the image channel. - * @param {RequestOptions} options - * @return {Promise>} */ - listStyle(options?: RequestOptions): Promise> + listStyle(options?: RequestOptions): Promise; /** * todo - * @param {string} styleName - * @param {RequestOptions} options - * @return {Promise} */ - deleteStyle(styleName: string, options?: RequestOptions): Promise + deleteStyle(styleName: string, options?: RequestOptions): Promise; /** * Create a signature url for directly download. - * @param {string} name - * @param {{expires?: string; timeout?: string}} options - * @return {string} */ - signatureUrl(name: string, options?: { expires?: string, timeout?: string }): string + signatureUrl(name: string, options?: { expires?: string, timeout?: string }): string; } diff --git a/types/ali-oss/ali-oss-tests.ts b/types/ali-oss/ali-oss-tests.ts index a9c39ab199..96f817cca8 100644 --- a/types/ali-oss/ali-oss-tests.ts +++ b/types/ali-oss/ali-oss-tests.ts @@ -5,8 +5,7 @@ const client = new OSS({ accessKeySecret: 'your access secret', bucket: 'your bucket name', region: 'oss-cn-hangzhou' -}) - +}); const ImageClient = OSS.ImageClient({ imageHost: 'host', @@ -16,7 +15,7 @@ const ImageClient = OSS.ImageClient({ internal: false, region: "", timeout: 2000 -}) +}); const cluster = OSS.Cluster({ clusters: [ @@ -32,4 +31,4 @@ const cluster = OSS.Cluster({ }, ], schedule: 'masterSlave', -}) +}); diff --git a/types/ali-oss/index.d.ts b/types/ali-oss/index.d.ts index b7eba95d62..c3fa0dd10b 100644 --- a/types/ali-oss/index.d.ts +++ b/types/ali-oss/index.d.ts @@ -1,443 +1,443 @@ -// Type definitions for ali-oss 6.0.1 +// Type definitions for ali-oss 6.0 // Project: https://github.com/ali-sdk/ali-oss // Definitions by: Ptrdu // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 -import * as ImageClientDefinition from './ImageClient' -import * as ClusterDefinition from "./Cluster" +import * as ImageClientDefinition from './ImageClient'; +import * as ClusterDefinition from "./Cluster"; -export * from './ImageClient' -export * from './Cluster' +export * from './ImageClient'; +export * from './Cluster'; export interface Options { - accessKeyId: string, // access secret you create - accessKeySecret: string, // access secret you create - stsToken?: string, // used by temporary authorization - bucket?: string, // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. - endpoint?: string, // oss region domain. It takes priority over region. - region?: string, // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou. - internal?: boolean, // access OSS with aliyun internal network or not, default is false. If your servers are running on aliyun too, you can set true to save lot of money. - secure?: boolean, // instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol. - timeout?: string | number // instance level timeout for all operations, default is 60s + accessKeyId: string; // access secret you create + accessKeySecret: string; // access secret you create + stsToken?: string; // used by temporary authorization + bucket?: string; // the default bucket you want to access If you don't have any bucket, please use putBucket() create one first. + endpoint?: string; // oss region domain. It takes priority over region. + region?: string; // the bucket data region location, please see Data Regions, default is oss-cn-hangzhou. + internal?: boolean; // access OSS with aliyun internal network or not, default is false. If your servers are running on aliyun too, you can set true to save lot of money. + secure?: boolean; // instruct OSS client to use HTTPS (secure: true) or HTTP (secure: false) protocol. + timeout?: string | number; // instance level timeout for all operations, default is 60s } -export type Bucket = { - name: string, - region: string, - creationDate: string, - StorageClass: StorageType +export interface Bucket { + name: string; + region: string; + creationDate: string; + StorageClass: StorageType; } -export type StorageType = "Standard" | "IA" | "Archive" +export type StorageType = "Standard" | "IA" | "Archive"; -export type ACLType = "public-read-write" | "public-read" | "and private" +export type ACLType = "public-read-write" | "public-read" | "and private"; export type HTTPMethods = "GET" | "POST" | "DELETE" | "PUT"; export interface RequestOptions { // the operation timeout - timeout?: number + timeout?: number; } -export type RuleStatusType = "Enabled" | "Disabled" +export type RuleStatusType = "Enabled" | "Disabled"; export interface LifecycleRule { - id?: string, // rule id, if not set, OSS will auto create it with random string. - prefix: string, // store prefix - status: RuleStatusType, // rule status, allow values: Enabled or Disabled - days?: number | string, // expire after the days - date: string // expire date, e.g.: 2022-10-11T00:00:00.000Z date and days only set one. + id?: string; // rule id, if not set, OSS will auto create it with random string. + prefix: string; // store prefix + status: RuleStatusType; // rule status, allow values: Enabled or Disabled + days?: number | string; // expire after the days + date: string; // expire date, e.g.: 2022-10-11T00:00:00.000Z date and days only set one. } export interface CORSRule { - allowedOrigin: string | Array, // configure for Access-Control-Allow-Origin header - allowedMethod: string | Array, // configure for Access-Control-Allow-Methods header - allowedHeader?: string | Array, // configure for Access-Control-Allow-Headers header - exposeHeader?: string | Array, // configure for Access-Control-Expose-Headers header - maxAgeSeconds?: string | Array, // configure for Access-Control-Max-Age header + allowedOrigin: string | string[]; // configure for Access-Control-Allow-Origin header + allowedMethod: string | string[]; // configure for Access-Control-Allow-Methods header + allowedHeader?: string | string[]; // configure for Access-Control-Allow-Headers header + exposeHeader?: string | string[]; // configure for Access-Control-Expose-Headers header + maxAgeSeconds?: string | string[]; // configure for Access-Control-Max-Age header } export interface OwnerType { - id: string, - displayName: string + id: string; + displayName: string; } export interface ObjectMeta { - name: string, // object name on oss - lastModified: string, // object last modified GMT date, e.g.: 2015-02-19T08:39:44.000Z - etag: string, // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" - type: string, // object type, e.g.: Normal - size: number, // object size, e.g.: 344606 - storageClass: StorageType, - owner: OwnerType, + name: string; // object name on oss + lastModified: string; // object last modified GMT date, e.g.: 2015-02-19T08:39:44.000Z + etag: string; // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" + type: string; // object type, e.g.: Normal + size: number; // object size, e.g.: 344606 + storageClass: StorageType; + owner: OwnerType; } export interface NormalSuccessResponse { - //response status - status: number, + // response status + status: number; // response headers - headers: object, // todo the object in detail + headers: object; // todo the object in detail // response size - size: number, + size: number; // request total use time (ms) - rt: number + rt: number; } export interface UserMeta { - uid: number, - pid: number + uid: number; + pid: number; } export interface ObjectCallback { - url: string, // After a file is uploaded successfully, the OSS sends a callback request to this URL. - host?: string, // The host header value for initiating callback requests. - body: string, // The value of the request body when a callback is initiated, for example, key=$(key)&etag=$(etag)&my_var=$(x:my_var). - contentType?: string, // The Content-Type of the callback requests initiatiated, It supports application/x-www-form-urlencoded and application/json, and the former is the default value. - customValue?: object, - headers?: object // extra headers, detail see RFC 2616 + url: string; // After a file is uploaded successfully, the OSS sends a callback request to this URL. + host?: string; // The host header value for initiating callback requests. + body: string; // The value of the request body when a callback is initiated, for example, key=$(key)&etag=$(etag)&my_var=$(x:my_var). + contentType?: string; // The Content-Type of the callback requests initiatiated, It supports application/x-www-form-urlencoded and application/json, and the former is the default value. + customValue?: object; + headers?: object; // extra headers, detail see RFC 2616 } export interface ModifyData { - lastModified: string, // object last modified GMT string - etag: string // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" + lastModified: string; // object last modified GMT string + etag: string; // object etag contains ", e.g.: "5B3C1A2E053D763E1B002CC607C5A0FE" } export interface Checkpoint { - file: any, // The file object selected by the user, if the browser is restarted, it needs the user to manually trigger the settings - name: string, // object key - fileSize: number, - partSize: number, - uploadId: string, - doneParts: Array<{ number: number, etag: string }> + file: any; // The file object selected by the user, if the browser is restarted, it needs the user to manually trigger the settings + name: string; // object key + fileSize: number; + partSize: number; + uploadId: string; + doneParts: Array<{ number: number, etag: string }>; } export interface ObjectPart { - PartNumber: number, - LastModified: any, // {Date} Time when a part is uploaded. - ETag: string, - size: number + PartNumber: number; + LastModified: any; // {Date} Time when a part is uploaded. + ETag: string; + size: number; } export interface Upload { - name: string, - uploadId: string, - initiated: any + name: string; + uploadId: string; + initiated: any; } export interface Channel { - Name: string, - Description: string, - Status: string, - LastModified: string, - PublishUrls: Array, - PlayUrls: Array + Name: string; + Description: string; + Status: string; + LastModified: string; + PublishUrls: string[]; + PlayUrls: string[]; } export interface ChannelHistory { - StartTime: string, // - EndTime: string, - RemoteAddr: string // the remote addr + StartTime: string; // + EndTime: string; + RemoteAddr: string; // the remote addr } // parameters type export interface ListBucketsQueryType { - prefix?: string, // search buckets using prefix key - marker?: string, // search start from marker, including marker key - 'max-keys'?: string | number // max buckets, default is 100, limit to 1000 + prefix?: string; // search buckets using prefix key + marker?: string; // search start from marker, including marker key + 'max-keys'?: string | number; // max buckets, default is 100, limit to 1000 } export interface PutBucketOptions { - timeout: number, - storageClass: StorageType + timeout: number; + storageClass: StorageType; } export interface PutBucketWebsiteConfig { - index: string, // default page, e.g.: index.html - error?: string // error page, e.g.: 'error.html' + index: string; // default page, e.g.: index.html + error?: string; // error page, e.g.: 'error.html' } export interface ListObjectsQuery { - prefix?: string, // search object using prefix key - marker?: string, // search start from marker, including marker key - delimiter?: string, // delimiter search scope e.g. / only search current dir, not including subdir - 'max-keys': string | number // max objects, default is 100, limit to 1000 + prefix?: string; // search object using prefix key + marker?: string; // search start from marker, including marker key + delimiter?: string; // delimiter search scope e.g. / only search current dir, not including subdir + 'max-keys': string | number; // max objects, default is 100, limit to 1000 } export interface ListObjectResult { - objects: Array, - prefixes: Array, - isTruncated: boolean, - nextMarker: string, - res: NormalSuccessResponse + objects: ObjectMeta[]; + prefixes: string[]; + isTruncated: boolean; + nextMarker: string; + res: NormalSuccessResponse; } export interface PutObjectOptions { - timeout?: number, // the operation timeout - mime?: string, // custom mime, will send with Content-Type entity header - meta?: UserMeta, // user meta, will send with x-oss-meta- prefix string e.g.: { uid: 123, pid: 110 } - callback: ObjectCallback, + timeout?: number; // the operation timeout + mime?: string; // custom mime, will send with Content-Type entity header + meta?: UserMeta; // user meta, will send with x-oss-meta- prefix string e.g.: { uid: 123, pid: 110 } + callback: ObjectCallback; } export interface PutObjectResult { - name: string, - data: object, - res: NormalSuccessResponse + name: string; + data: object; + res: NormalSuccessResponse; } export interface PutStreamOptions { - contentLength?: number, // the stream length, chunked encoding will be used if absent - timeout: number, // the operation timeout - mime: string, // custom mime, will send with Content-Type entity header - meta: UserMeta, - callback: ObjectCallback + contentLength?: number; // the stream length, chunked encoding will be used if absent + timeout: number; // the operation timeout + mime: string; // custom mime, will send with Content-Type entity header + meta: UserMeta; + callback: ObjectCallback; } export interface AppendObjectOptions { - position?: string, // specify the position which is the content length of the latest object - timeout?: number, // the operation timeout - mime?: string, // custom mime, will send with Content-Type entity header - meta?: UserMeta, - headers?: object + position?: string; // specify the position which is the content length of the latest object + timeout?: number; // the operation timeout + mime?: string; // custom mime, will send with Content-Type entity header + meta?: UserMeta; + headers?: object; } export interface AppendObjectResult { - name: string, - url: string, // the url of oss - res: NormalSuccessResponse, - nextAppendPosition: string, // the next position + name: string; + url: string; // the url of oss + res: NormalSuccessResponse; + nextAppendPosition: string; // the next position } export interface HeadObjectOptions { - timeout?: number, - headers?: object + timeout?: number; + headers?: object; } export interface HeadObjectResult { - status: number, // response status, maybe 200 or 304 - meta: UserMeta, - res: NormalSuccessResponse + status: number; // response status, maybe 200 or 304 + meta: UserMeta; + res: NormalSuccessResponse; } export interface GetObjectOptions { - timeout?: number, - process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} - headers?: object + timeout?: number; + process?: string; // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} + headers?: object; } export interface GetObjectResult { - content?: any, // file content buffer if file parameter is null or ignore - res: NormalSuccessResponse + content?: any; // file content buffer if file parameter is null or ignore + res: NormalSuccessResponse; } export interface GetStreamOptions { - timeout?: number, - process?: string, // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} - headers?: object + timeout?: number; + process?: string; // image process params, will send with x-oss-process e.g.: {process: 'image/resize,w_200'} + headers?: object; } export interface GetStreamResult { - stream?: any, // readable stream instance if response status is not 200, stream will be null. - res: NormalSuccessResponse + stream?: any; // readable stream instance if response status is not 200, stream will be null. + res: NormalSuccessResponse; } export interface CopyObjectOptions { - timeout?: number, - meta?: UserMeta, - headers?: object + timeout?: number; + meta?: UserMeta; + headers?: object; } export interface CopyAndPutMetaResult { - data: ModifyData, - res: NormalSuccessResponse + data: ModifyData; + res: NormalSuccessResponse; } export interface DeleteMultiOptions { - quite?: boolean // quiet mode or verbose mode, default is false, verbose mode quiet mode: if all objects delete succes, return emtpy response. otherwise return delete error object results. verbose mode: return all object delete results. - timeout?: number + quite?: boolean; // quiet mode or verbose mode, default is false + timeout?: number; } export interface DeleteMultiResult { - deleted?: Array // deleted object names list - res: NormalSuccessResponse + deleted?: string[]; // deleted object names list + res: NormalSuccessResponse; } export interface ResponseHeaderType { - 'content-type'?: string, - 'content-disposition'? :string, - 'cache-control'?: string + 'content-type'?: string; + 'content-disposition'?: string; + 'cache-control'?: string; } export interface SignatureUrlOptions { - expires?: number, // after expires seconds, the url will become invalid, default is 1800 - method?: HTTPMethods, // the HTTP method, default is 'GET' - 'Content-Type'?: string, // set the request content type - process?: string, - response?: ResponseHeaderType, // set the response headers for download - callback?: ObjectCallback + expires?: number; // after expires seconds, the url will become invalid, default is 1800 + method?: HTTPMethods; // the HTTP method, default is 'GET' + 'Content-Type'?: string; // set the request content type + process?: string; + response?: ResponseHeaderType; // set the response headers for download + callback?: ObjectCallback; } export interface GetACLResult { - acl: ACLType, - res: NormalSuccessResponse + acl: ACLType; + res: NormalSuccessResponse; } export interface InitMultipartUploadOptions { - timeout?: number, - mime?: string, // Mime file type - meta?: UserMeta, - headers?: object + timeout?: number; + mime?: string; // Mime file type + meta?: UserMeta; + headers?: object; } export interface InitMultipartUploadResult { - res: { status: number, headers: object, size: number, rt: number } - bucket: string, // bucket name - name: string, // object name store on OSS - uploadId: string, // upload id, use for uploadPart, completeMultipart + res: { status: number, headers: object, size: number, rt: number }; + bucket: string; // bucket name + name: string; // object name store on OSS + uploadId: string; // upload id, use for uploadPart, completeMultipart } export interface UploadPartResult { - name: string, - etag: string, - res: NormalSuccessResponse + name: string; + etag: string; + res: NormalSuccessResponse; } export interface CompleteMultipartUploadOptions { - timeout?: number, - callback?: ObjectCallback, - headers?: object + timeout?: number; + callback?: ObjectCallback; + headers?: object; } export interface CompleteMultipartUploadResult { - bucket: string, - name: string, - etag: string, - data: object, - res: NormalSuccessResponse + bucket: string; + name: string; + etag: string; + data: object; + res: NormalSuccessResponse; } export interface MultipartUploadOptions { - parallel?: number, // the number of parts to be uploaded in parallel - partSize?: number, // the suggested size for each part - progress?: Function, // the progress callback called after each successful upload of one part, it will be given three parameters: (percentage {Number}, checkpoint {Object}, res {Object}) - checkpoint?: Checkpoint, // the checkpoint to resume upload, if this is provided, it will continue the upload from where interrupted, otherwise a new multipart upload will be created. - meta?: UserMeta, - mime?: string, - callback?: ObjectCallback, - headers?: object, - timeout?: number - copyheaders?: object, // {Object} only uploadPartCopy api used, detail + parallel?: number; // the number of parts to be uploaded in parallel + partSize?: number; // the suggested size for each part + progress?: (...args: any[]) => any; // the progress callback called after each successful upload of one part + checkpoint?: Checkpoint; // the checkpoint to resume upload, if this is provided, it will continue the upload from where interrupted, otherwise a new multipart upload will be created. + meta?: UserMeta; + mime?: string; + callback?: ObjectCallback; + headers?: object; + timeout?: number; + copyheaders?: object; // {Object} only uploadPartCopy api used, detail } export interface MultipartUploadResult { - bucket: string, - name: string, - etag: string, - data: object, - res: NormalSuccessResponse + bucket: string; + name: string; + etag: string; + data: object; + res: NormalSuccessResponse; } export interface MultipartUploadCopyResult { - bucket: string, - name: string, - etag: string, - res: NormalSuccessResponse + bucket: string; + name: string; + etag: string; + res: NormalSuccessResponse; } export interface MultipartUploadCopySourceData { - sourceKey: string, // the source object name - sourceBucketName: string, // sourceData. the source bucket name - startOffset: number, // data copy start byte offset, e.g: 0 - endOffset: number // data copy end byte offset, e.g: 102400 + sourceKey: string; // the source object name + sourceBucketName: string; // sourceData. the source bucket name + startOffset: number; // data copy start byte offset, e.g: 0 + endOffset: number; // data copy end byte offset, e.g: 102400 } export interface ListPartsQuery { - 'max-parts': number, // The maximum part number in the response of the OSS. default value: 1000. - 'part-number-marker': number, // Starting position of a specific list. A part is listed only when the part number is greater than the value of this parameter. - 'encoding-type': string // Specify the encoding of the returned content and the encoding type. Optional value: url + 'max-parts': number; // The maximum part number in the response of the OSS. default value: 1000. + 'part-number-marker': number; // Starting position of a specific list. A part is listed only when the part number is greater than the value of this parameter. + 'encoding-type': string; // Specify the encoding of the returned content and the encoding type. Optional value: url } export interface ListPartsResult { - uploadId: string, - bucket: string, - name: string, - PartNumberMarker: number, - nextPartNumberMarker: number, - maxParts: number, - isTruncated: boolean, - parts: Array, - res: NormalSuccessResponse + uploadId: string; + bucket: string; + name: string; + PartNumberMarker: number; + nextPartNumberMarker: number; + maxParts: number; + isTruncated: boolean; + parts: ObjectPart[]; + res: NormalSuccessResponse; } export interface ListUploadsQuery { - prefix?: string, - 'max-uploads'?: number, - 'key-marker'?: string, - 'upload-id-marker'?: string + prefix?: string; + 'max-uploads'?: number; + 'key-marker'?: string; + 'upload-id-marker'?: string; } export interface ListUploadsResult { - res: NormalSuccessResponse, - bucket: string, - nextKeyMarker: any, - nextUploadIdMarker: any, - isTruncated: boolean, - uploads: Array + res: NormalSuccessResponse; + bucket: string; + nextKeyMarker: any; + nextUploadIdMarker: any; + isTruncated: boolean; + uploads: Upload[]; } export interface PutChannelConf { - Description?: string, - Status?: string, + Description?: string; + Status?: string; Target?: { Type: string, FragDuration: number, FragCount: number, PlaylistName: string - } + }; } export interface PutChannelResult { - publishUrls: Array, - playUrls: Array, - res: NormalSuccessResponse + publishUrls: string[]; + playUrls: string[]; + res: NormalSuccessResponse; } export interface GetChannelResult { - Status: string, - ConnectedTime?: string, - RemoteAddr?: string, - Video?: object, - Audio?: object, - res: NormalSuccessResponse + Status: string; + ConnectedTime?: string; + RemoteAddr?: string; + Video?: object; + Audio?: object; + res: NormalSuccessResponse; } export interface ListChannelsQuery { - prefix: string, // the channel id prefix (returns channels with this prefix) - marker: string, // the channle id marker (returns channels after this id) - 'max-keys ': number // max number of channels to return + prefix: string; // the channel id prefix (returns channels with this prefix) + marker: string; // the channel id marker (returns channels after this id) + 'max-keys ': number; // max number of channels to return } export interface ListChannelsResult { - channels: Array - nextMarker: string | null, - isTruncated: boolean, - res: NormalSuccessResponse + channels: Channel[]; + nextMarker: string | null; + isTruncated: boolean; + res: NormalSuccessResponse; } export interface ChannelHistoryResult { - records: ChannelHistory, - res: NormalSuccessResponse + records: ChannelHistory; + res: NormalSuccessResponse; } export interface GetRtmpUrlOptions { - expires?: number, // the expire time in seconds of the url - params?: object, // the additional paramters for url, e.g.: {playlistName: 'play.m3u8'} - timeout?: number // the operation timeout + expires?: number; // the expire time in seconds of the url + params?: object; // the additional parameters for url, e.g.: {playlistName: 'play.m3u8'} + timeout?: number; // the operation timeout } export default class OSS { // the image client - public static ImageClient: (options: ImageClientDefinition.ImageClientOptions) => ImageClientDefinition.ImageClient - public static Cluster: (options: ClusterDefinition.ClusterOptions) => ClusterDefinition.Cluster + static ImageClient: (options: ImageClientDefinition.ImageClientOptions) => ImageClientDefinition.ImageClient; + static Cluster: (options: ClusterDefinition.ClusterOptions) => ClusterDefinition.Cluster; constructor(options: Options) @@ -446,510 +446,315 @@ export default class OSS { // base operators /** * List buckets in this account. - * @param {ListBucketsQueryType | null} query - query parameters, default is null - * @param {RequestOptions} options - optional parameters - * timeout - the operation timeout - * @return {Promise>} */ - listBuckets(query: ListBucketsQueryType | null, options?: RequestOptions): Promise> + listBuckets(query: ListBucketsQueryType | null, options?: RequestOptions): Promise; /** * Create a new bucket. - * @param {string} name - bucket name If bucket exists and not belong to current account, will throw BucketAlreadyExistsError. - * If bucket not exists, will create a new bucket and set it's ACL. - * @param {PutBucketOptions} options - optional parameters - * @return { Promise<{ bucket: string, res: NormalSuccessResponse }> } */ - putBucket(name: string, options?: PutBucketOptions): Promise<{ bucket: string, res: NormalSuccessResponse }> + putBucket(name: string, options?: PutBucketOptions): Promise<{ bucket: string, res: NormalSuccessResponse }>; /** * Use the bucket. - * @param {string} name - bucket name */ - useBucket(name: string): void + useBucket(name: string): void; /** * Delete an empty bucket. - * @param {string} name - bucket name If bucket is not empty, will throw BucketNotEmptyError. If bucket is not exists, will throw NoSuchBucketError. - * @param {RequestOptions} options - * @return {Promise} */ - deleteBucket(name: string, options?: RequestOptions): Promise + deleteBucket(name: string, options?: RequestOptions): Promise; /** * Get bucket information,include CreationDate、ExtranetEndpoint、IntranetEndpoint、Location、Name、StorageClass、 Owner、AccessControlList - * @param {string} name - bucket name - * @return {Promise} // todo the official document miss the return type */ - getBucketInfo(name: string): Promise + getBucketInfo(name: string): Promise; /** * Get bucket location - * @param {string} name - bucket name - * @return {Promise} // todo the official document miss the return type */ - getBucketLocation(name: string): Promise + getBucketLocation(name: string): Promise; // ACL operations /** * Update the bucket ACL. - * @param {string} name - bucket name - * @param {ACLType} acl - access control list, current available: public-read-write, public-read and private - * @param {RequestOptions} options - * @return {Promise} */ - putBucketACL(name: string, acl: ACLType, options?: RequestOptions): Promise + putBucketACL(name: string, acl: ACLType, options?: RequestOptions): Promise; /** * Get the bucket ACL. - * @param {string} name - bucket name - * @param {RequestOptions} options - * @return {Promise<{ acl: string, res: NormalSuccessResponse }>} * acl - acl settings string */ - getBucketACL(name: string, options?: RequestOptions): Promise<{ acl: string, res: NormalSuccessResponse }> + getBucketACL(name: string, options?: RequestOptions): Promise<{ acl: string, res: NormalSuccessResponse }>; // logging operations /** * Update the bucket logging settings. Log file will create every one hour and name format: -YYYY-mm-DD-HH-MM-SS-UniqueString. - * @param {string} name - bucket name - * @param {string} prefix - prefix path name to store the log files - * @param {RequestOptions} options - * @return {Promise} */ - putBucketLogging(name: string, prefix?: string, options?: RequestOptions): Promise + putBucketLogging(name: string, prefix?: string, options?: RequestOptions): Promise; /** * Get the bucket logging settings. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise<{ enable: boolean, prefix: string | null, res: NormalSuccessResponse }>} */ - getBucketLogging(name: string, options?: RequestOptions): Promise<{ enable: boolean, prefix: string | null, res: NormalSuccessResponse }> + getBucketLogging(name: string, options?: RequestOptions): Promise<{ enable: boolean, prefix: string | null, res: NormalSuccessResponse }>; /** * Delete the bucket logging settings. - * @param {string} name - bucket name - * @param {RequestOptions} options - * @return {Promise} */ - deleteBucketLogging(name: string, options?: RequestOptions): Promise + deleteBucketLogging(name: string, options?: RequestOptions): Promise; // Website operations /** * Set the bucket as a static website. - * @param {string} name - bucket name - * @param {PutBucketWebsiteConfig} config - * @return {Promise} */ - putBucketWebsite(name: string, config: PutBucketWebsiteConfig): Promise + putBucketWebsite(name: string, config: PutBucketWebsiteConfig): Promise; /** * Get the bucket website config. - * @param {string} name - bucket name - * @param {RequestOptions} options - * @return {Promise<{ index: string, error: string, res: NormalSuccessResponse }>} */ - getBucketWebsite(name: string, options?: RequestOptions): Promise<{ index: string, error: string, res: NormalSuccessResponse }> + getBucketWebsite(name: string, options?: RequestOptions): Promise<{ index: string, error: string, res: NormalSuccessResponse }>; /** * Delete the bucket website config. - * @param {string} name - bucket name - * @param {RequestOptions} options - * @return {Promise} */ - deleteBucketWebsite(name: string, options?: RequestOptions): Promise + deleteBucketWebsite(name: string, options?: RequestOptions): Promise; // referer operations /** * Set the bucket request Referer white list. - * @param {string} name - * @param {boolean} allowEmpty - allow empty request referer or not - * @param {Array} referers - Referer white list, e.g.: ['https://npm.taobao.org', 'http://cnpmjs.org'] - * @param {RequestOptions} options - * @return {Promise} */ - putBucketReferer(name: string, allowEmpty: boolean, referers: Array, options?: RequestOptions): Promise + putBucketReferer(name: string, allowEmpty: boolean, referers: string[], options?: RequestOptions): Promise; /** * Get the bucket request Referer white list. - * @param {string} name - bucket name - * @param {RequestOptions} options - * @return {Promise<{ allowEmpty: boolean, referers: Array, res: NormalSuccessResponse }>} */ - getBucketReferer(name: string, options?: RequestOptions): Promise<{ allowEmpty: boolean, referers: Array, res: NormalSuccessResponse }> + getBucketReferer(name: string, options?: RequestOptions): Promise<{ allowEmpty: boolean, referers: string[], res: NormalSuccessResponse }>; /** * Delete the bucket request Referer white list. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise} */ - deleteBucketReferer(name: string, options?: RequestOptions): Promise + deleteBucketReferer(name: string, options?: RequestOptions): Promise; // lifecycle operations /** * Set the bucket object lifecycle. - * @param {string} name - * @param {Array} rules - rule config list - * @param {RequestOptions} options - * @return {Promise} */ - putBucketLifecycle(name: string, rules: Array, options?: RequestOptions): Promise + putBucketLifecycle(name: string, rules: LifecycleRule[], options?: RequestOptions): Promise; /** * Get the bucket object lifecycle. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise<{ rules: Array, res: NormalSuccessResponse }>} */ - getBucketLifecycle(name: string, options?: RequestOptions): Promise<{ rules: Array, res: NormalSuccessResponse }> + getBucketLifecycle(name: string, options?: RequestOptions): Promise<{ rules: LifecycleRule[], res: NormalSuccessResponse }>; /** * Delete the bucket object lifecycle. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise} */ - deleteBucketLifecycle(name: string, options?: RequestOptions): Promise + deleteBucketLifecycle(name: string, options?: RequestOptions): Promise; // CORS operations /** * Set CORS rules of the bucket object - * @param {string} name - * @param {Array} rules - * @param {RequestOptions} options - * @return {Promise} */ - putBucketCORS(name: string, rules: Array, options?: RequestOptions): Promise + putBucketCORS(name: string, rules: CORSRule[], options?: RequestOptions): Promise; /** * Get CORS rules of the bucket object. - * @param {string} name - * @return {Promise<{rules: Array; res: NormalSuccessResponse}>} */ - getBucketCORS(name: string): Promise<{ rules: Array, res: NormalSuccessResponse }> + getBucketCORS(name: string): Promise<{ rules: CORSRule[], res: NormalSuccessResponse }>; /** * Delete CORS rules of the bucket object. - * @param {string} name - * @return {Promise} */ - deleteBucketCORS(name: string): Promise + deleteBucketCORS(name: string): Promise; /********************************************************** Object operations ********************************************/ /** * List objects in the bucket. - * @param {ListObjectsQuery | null} query - * @param {RequestOptions} options - * @return {Promise} */ - list(query: ListObjectsQuery | null, options: RequestOptions): Promise + list(query: ListObjectsQuery | null, options: RequestOptions): Promise; /** * Add an object to the bucket. - * @param {string} name - object name store on OSS - * @param file - {String|Buffer|ReadStream|File(only support Browser)|Blob(only support Browser)} object local path, content buffer or ReadStream content instance use in Node, Blob and html5 File - * @param {PutObjectOptions} options - optional parameters - * @return {Promise} */ - put(name: string, file: any, options?: PutObjectOptions): Promise + put(name: string, file: any, options?: PutObjectOptions): Promise; /** * Add a stream object to the bucket. - * @param {string} name - object name store on OSS - * @param stream - object ReadStream content instance - * @param {PutStreamOptions} options - optional parameters - * @return {Promise<{name: string; res: NormalSuccessResponse}>} */ - putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }> + putStream(name: string, stream: any, options?: PutStreamOptions): Promise<{ name: string, res: NormalSuccessResponse }>; /** * Append an object to the bucket, it's almost same as put, but it can add content to existing object rather than override it. - * @param {string} name - * @param file - * @param {AppendObjectOptions} options - * @return {Promise} */ - append(name: string, file: any, options?: AppendObjectOptions): Promise + append(name: string, file: any, options?: AppendObjectOptions): Promise; /** * Get the Object url. If provide baseUrl, will use baseUrl instead the default endpoint. - * @param {string} name - * @param {string} baseUrl - * @return {string} */ - getObjectUrl(name: string, baseUrl?: string): string + getObjectUrl(name: string, baseUrl?: string): string; /** * Get the Object url. If provide baseUrl, will use baseUrl instead the default bucket and endpoint. Suggest use generateObjectUrl instead of getObjectUrl. - * @param {string} name - * @param {string} baseUrl - * @return {string} */ - generateObjectUrl(name: string, baseUrl?: string): string + generateObjectUrl(name: string, baseUrl?: string): string; /** * Head an object and get the meta info. - * @param {string} name - * @param {HeadObjectOptions} options - * @return {Promise} */ - head(name: string, options?: HeadObjectOptions): Promise + head(name: string, options?: HeadObjectOptions): Promise; /** * Get an object from the bucket. - * @param {string} name - * @param file - {String|WriteStream} file path or WriteStream instance to store the content If file is null or ignore this parameter, function will return info contains content property. - * @param {GetObjectOptions} options - * @return {Promise} */ - get(name: string, file?: any, options?: GetObjectOptions): Promise + get(name: string, file?: any, options?: GetObjectOptions): Promise; /** * Get an object read stream. - * @param {string} name - * @param {GetStreamOptions} options - * @return {Promise} */ - getStream(name?: string, options?: GetStreamOptions): Promise + getStream(name?: string, options?: GetStreamOptions): Promise; /** * Delete an object from the bucket. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise} */ - delete(name: string, options?: RequestOptions): Promise + delete(name: string, options?: RequestOptions): Promise; /** * Copy an object from sourceName to name. - * @param {string} name - object name store on OSS - * @param {string} sourceName - source object name If sourceName start with /, meaning it's a full name contains the bucket name. e.g.: /otherbucket/logo.png meaning copy otherbucket logn.png object to current bucket. - * @param {CopyObjectOptions} options - * @return {Promise} */ - copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise + copy(name: string, sourceName: string, options?: CopyObjectOptions): Promise; /** * Set an exists object meta. - * @param {string} name - * @param {UserMeta} meta - * @param {RequestOptions} options - * @return {Promise} */ - putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise + putMeta(name: string, meta: UserMeta, options: RequestOptions): Promise; /** * Delete multi objects in one request. - * @param {Array} names - object names, max 1000 objects in once. - * @param {DeleteMultiOptions} options - * @return {Promise} */ - deleteMulti(names: Array, options?: DeleteMultiOptions): Promise + deleteMulti(names: string[], options?: DeleteMultiOptions): Promise; /** * Create a signature url for download or upload object. When you put object with signatureUrl ,you need to pass Content-Type.Please look at the example. - * @param {string} name - * @param {SignatureUrlOptions} options - * @return {string} */ - signatureUrl(name: string, options?: SignatureUrlOptions): string + signatureUrl(name: string, options?: SignatureUrlOptions): string; /** * Set object's ACL. - * @param {string} name - * @param {ACLType} acl - * @param {RequestOptions} options - * @return {Promise} */ - putACL(name: string, acl: ACLType, options?: RequestOptions): Promise + putACL(name: string, acl: ACLType, options?: RequestOptions): Promise; /** * Get object's ACL. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise} */ - getACL(name: string, options?: RequestOptions): Promise + getACL(name: string, options?: RequestOptions): Promise; /** * Restore Object. - * @param {string} name - * @param {RequestOptions} options - * @return {Promise} */ - restore(name: string, options?: RequestOptions): Promise + restore(name: string, options?: RequestOptions): Promise; /** - * - * @param {string} name - * @param {InitMultipartUploadOptions} options - * @return {Promise} + * multi upload */ - initMultipartUpload(name: string, options?: InitMultipartUploadOptions): Promise + initMultipartUpload(name: string, options?: InitMultipartUploadOptions): Promise; /** * After initiating a Multipart Upload event, you can upload data in parts based on the specified object name and Upload ID. - * @param {string} name - object name - * @param {string} uploadId - get by initMultipartUpload api - * @param {number} partNo - range is 1-10000, If this range is exceeded, OSS returns the InvalidArgument's error code. - * @param file - is File or FileName, the whole file - Multipart Upload requires that the size of any Part other than the last Part is greater than 100KB. - In Node you can use File or FileName, but in browser you only can use File. - * @param {number} start - part start bytes e.g: 102400 - * @param {number} end - part end bytes e.g: 204800 - * @param {RequestOptions} options - * @return {Promise} */ - uploadPart(name: string, uploadId: string, partNo: number, file: any, start: number, end: number, options?: RequestOptions): Promise + uploadPart(name: string, uploadId: string, partNo: number, file: any, start: number, end: number, options?: RequestOptions): Promise; /** - * Using Upload Part Copy, you can copy data from an existing object and upload a part of the data. When copying a file larger than 1 GB, you must use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object. - * @param {string} name - * @param {string} uploadId - * @param {number} partNo - * @param {string} range - * @param {{sourceKey: string; sourceBucketName: string}} sourceData - * @param {{timeout?: number; headers?: object}} options - * @return {Promise} + * Using Upload Part Copy, you can copy data from an existing object and upload a part of the data. + * When copying a file larger than 1 GB, you must use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object. */ - uploadPartCopy(name: string, uploadId: string, partNo: number, range: string, sourceData: { sourceKey: string, sourceBucketName: string }, options: { timeout?: number, headers?: object }): Promise + uploadPartCopy( + name: string, + uploadId: string, + partNo: number, + range: string, + sourceData: { sourceKey: string, sourceBucketName: string }, + options: { timeout?: number, headers?: object } + ): Promise; /** * After uploading all data parts, you must call the Complete Multipart Upload API to complete Multipart Upload for the entire file. - * @param {string} name - * @param {string} uploadId - * @param {Array<{number: number; etag: string}>} parts - * @param {CompleteMultipartUploadOptions} options - * @return {Promise} */ - completeMultipartUpload(name: string, uploadId: string, parts: Array<{ number: number, etag: string }>, options?: CompleteMultipartUploadOptions): Promise + completeMultipartUpload( + name: string, + uploadId: string, + parts: Array<{ number: number, etag: string }>, + options?: CompleteMultipartUploadOptions + ): Promise; /** * Upload file with OSS multipart. - * this function contains initMultipartUpload, uploadPart, completeMultipartUpload. When you use multipartUpload api，if you encounter problems with ConnectionTimeoutError, you should handle ConnectionTimeoutError in your business code. - * How to resolve ConnectionTimeoutError, you can decrease partSize size 、 Increase timeout 、Retry request , or give tips in your business code; - * @param {string} name - * @param file - * @param {MultipartUploadOptions} options - * @return {Promise} */ - multipartUpload(name: string, file: any, options: MultipartUploadOptions): Promise + multipartUpload(name: string, file: any, options: MultipartUploadOptions): Promise; /** * Copy file with OSS multipart. * this function contains head, initMultipartUpload, uploadPartCopy, completeMultipartUpload. * When copying a file larger than 1 GB, you should use the Upload Part Copy method. If you want to copy a file smaller than 1 GB, see Copy Object. - * @param {string} name - * @param {MultipartUploadCopySourceData} sourceData - * @param {MultipartUploadOptions} options - * @return {Promise} */ - multipartUploadCopy(name: string, sourceData: MultipartUploadCopySourceData, options?: MultipartUploadOptions): Promise + multipartUploadCopy(name: string, sourceData: MultipartUploadCopySourceData, options?: MultipartUploadOptions): Promise; /** * The ListParts command can be used to list all successfully uploaded parts mapped to a specific upload ID, i.e.: those not completed and not aborted. - * @param {string} name - * @param {string} uploadId - * @param {ListPartsQuery} query - * @param {RequestOptions} options - * @return {Promise} */ - listParts(name: string, uploadId: string, query?: ListPartsQuery, options?: RequestOptions): Promise + listParts(name: string, uploadId: string, query?: ListPartsQuery, options?: RequestOptions): Promise; /** * List on-going multipart uploads, i.e.: those not completed and not aborted. - * @param {ListUploadsQuery} query - * @param {RequestOptions} options - * @return {Promise} */ - listUploads(query: ListUploadsQuery, options?: RequestOptions): Promise + listUploads(query: ListUploadsQuery, options?: RequestOptions): Promise; /** * Abort a multipart upload for object. - * @param {string} name - * @param {string} uploadId - * @param {RequestOptions} options - * @return {Promise} */ - abortMultipartUpload(name: string, uploadId: string, options?: RequestOptions): Promise + abortMultipartUpload(name: string, uploadId: string, options?: RequestOptions): Promise; /************************************************ RTMP Operations *************************************************************/ /** * Create a live channel. - * @param {string} id - * @param {PutChannelConf} conf - * @param {RequestOptions} options - * @return {Promise} */ - putChannel(id: string, conf: PutChannelConf, options?: RequestOptions): Promise + putChannel(id: string, conf: PutChannelConf, options?: RequestOptions): Promise; /** * Get live channel info. - * @param {string} id - * @param {RequestOptions} options - * @return {Promise<{data: PutChannelConf; res: NormalSuccessResponse}>} */ - getChannel(id: string, options?: RequestOptions): Promise<{ data: PutChannelConf, res: NormalSuccessResponse }> + getChannel(id: string, options?: RequestOptions): Promise<{ data: PutChannelConf, res: NormalSuccessResponse }>; /** * Delete a live channel. - * @param {string} id - * @param {RequestOptions} options - * @return {Promise} */ - deleteChannel(id: string, options?: RequestOptions): Promise + deleteChannel(id: string, options?: RequestOptions): Promise; /** * Change the live channel status. - * @param {string} id - * @param {string} status - * @param {RequestOptions} options - * @return {Promise} */ - putChannelStatus(id: string, status?: string, options?: RequestOptions): Promise + putChannelStatus(id: string, status?: string, options?: RequestOptions): Promise; /** * Get the live channel status. - * @param {string} id - * @param {RequestOptions} options - * @return {Promise} */ - getChannelStatus(id: string, options?: RequestOptions): Promise + getChannelStatus(id: string, options?: RequestOptions): Promise; /** * List channels. - * @param {ListChannelsQuery} query - * @param {RequestOptions} options - * @return {Promise} */ - listChannels(query: ListChannelsQuery, options?: RequestOptions): Promise + listChannels(query: ListChannelsQuery, options?: RequestOptions): Promise; /** * Get the live channel history. - * @param {string} id - * @param {RequestOptions} options - * @return {Promise} */ - getChannelHistory(id: string, options?: RequestOptions): Promise + getChannelHistory(id: string, options?: RequestOptions): Promise; /** * Create a VOD playlist for the channel. - * @param {string} id - * @param {string} name - * @param {{startTime: number; endTime: number}} time - * @param {RequestOptions} options - * @return {Promise} */ - createVod(id: string, name: string, time: { startTime: number, endTime: number }, options?: RequestOptions): Promise + createVod(id: string, name: string, time: { startTime: number, endTime: number }, options?: RequestOptions): Promise; /** * Get signatured rtmp url for publishing. - * @param {string} channelId - * @param {GetRtmpUrlOptions} options - * @return {string} */ - getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string - + getRtmpUrl(channelId?: string, options?: GetRtmpUrlOptions): string; } diff --git a/types/ali-oss/tsconfig.json b/types/ali-oss/tsconfig.json index b6f46ae8e8..62f030a4fd 100644 --- a/types/ali-oss/tsconfig.json +++ b/types/ali-oss/tsconfig.json @@ -6,7 +6,7 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": false, + "strictNullChecks": true, "strictFunctionTypes": true, "baseUrl": "../", "typeRoots": [ diff --git a/types/ali-oss/tslint.json b/types/ali-oss/tslint.json index a41bf5d19a..f93cf8562a 100644 --- a/types/ali-oss/tslint.json +++ b/types/ali-oss/tslint.json @@ -1,79 +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-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 e32ea94e933c8d7d426ef4ad9734fe4a2e8bdbdf Mon Sep 17 00:00:00 2001 From: quas94 Date: Fri, 28 Sep 2018 17:53:41 +1000 Subject: [PATCH 010/799] Add definitions for Dropbox Chooser --- .../dropbox-chooser/dropbox-chooser-tests.ts | 20 ++++++ types/dropbox-chooser/index.d.ts | 66 +++++++++++++++++++ types/dropbox-chooser/tsconfig.json | 24 +++++++ types/dropbox-chooser/tslint.json | 1 + 4 files changed, 111 insertions(+) create mode 100644 types/dropbox-chooser/dropbox-chooser-tests.ts create mode 100644 types/dropbox-chooser/index.d.ts create mode 100644 types/dropbox-chooser/tsconfig.json create mode 100644 types/dropbox-chooser/tslint.json diff --git a/types/dropbox-chooser/dropbox-chooser-tests.ts b/types/dropbox-chooser/dropbox-chooser-tests.ts new file mode 100644 index 0000000000..f0930733f8 --- /dev/null +++ b/types/dropbox-chooser/dropbox-chooser-tests.ts @@ -0,0 +1,20 @@ +// Tests for Dropbox Chooser DefinitelyTyped TS definitions + +const options: DropboxChooserOptions = { + success: (files: ReadonlyArray) => { + console.log('Success, selected files were:', files); + }, +}; + +const Dropbox = window.Dropbox!; +Dropbox.choose(options); + +const sampleFile: DropboxChooserFile = { + id: 'SAMPLE_ID', + name: 'HelloBox.jpg', + link: 'http://localhost/1.png', + bytes: 1024, + icon: 'http://localhost/icons/png.png', + thumbnailLink: 'http://localhost/thumbnails/1.png', + isDir: false, +}; diff --git a/types/dropbox-chooser/index.d.ts b/types/dropbox-chooser/index.d.ts new file mode 100644 index 0000000000..8c9db6f72d --- /dev/null +++ b/types/dropbox-chooser/index.d.ts @@ -0,0 +1,66 @@ +// Type definitions for Dropbox Chooser 1.0 +// Project: https://www.dropbox.com/developers/chooser +// Definitions by: Michael Su +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace Dropbox { + interface DropboxChooser { + choose(options: ChooserOptions): void; + } + + interface ChooserOptions { + // alled when a user selects an item in the Chooser + success(files: ReadonlyArray): void; + + // called when the user closes the dialog without selecting a file + cancel?(): void; + + // default: 'preview' + linkType?: 'preview' | 'direct'; + + // default: false + multiselect?: boolean; + + // eg. '.png' + extensions?: string[]; + + // default: false + folderselect?: boolean; + + // any positive number + sizeLimit?: number; + } + + interface File { + // Unique ID for the file, compatible with Dropbox API v2. + id: string; + + // Name of the file. + name: string; + + // URL to access the file, which varies depending on the linkType specified when the + // Chooser was triggered. + link: string; + + // Size of the file in bytes. + bytes: number; + + // URL to a 64x64px icon for the file based on the file's extension. + icon: string; + + // A thumbnail URL generated when the user selects images and videos. + // If the user didn't select an image or video, no thumbnail will be included. + thumbnailLink?: string; + + // whether or not the file is actually a directory + isDir: boolean; + } +} + +type DropboxChooser = Dropbox.DropboxChooser; +type DropboxChooserOptions = Dropbox.ChooserOptions; +type DropboxChooserFile = Dropbox.File; + +interface Window { + Dropbox?: DropboxChooser; +} diff --git a/types/dropbox-chooser/tsconfig.json b/types/dropbox-chooser/tsconfig.json new file mode 100644 index 0000000000..88fb15cc91 --- /dev/null +++ b/types/dropbox-chooser/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "dom", + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "dropbox-chooser-tests.ts" + ] +} diff --git a/types/dropbox-chooser/tslint.json b/types/dropbox-chooser/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/dropbox-chooser/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From fbe427753b27e80d2866bd1d5d92b8f5b8891336 Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Tue, 16 Oct 2018 10:05:50 -0500 Subject: [PATCH 011/799] 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 012/799] 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 730393928c0de536fc827c64c72609eac92f11fe Mon Sep 17 00:00:00 2001 From: juwar Date: Mon, 22 Oct 2018 09:13:40 -0700 Subject: [PATCH 013/799] Add maxFontSize and minFontSize to series that have it. --- types/highcharts/index.d.ts | 110 +++++++++++++++++++++++++++++++++++- 1 file changed, 108 insertions(+), 2 deletions(-) diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index dcde50413d..d3036a869a 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -4644,6 +4644,14 @@ declare namespace Highcharts { * allows setting a separate color for the line without altering the fillColor. */ lineColor?: string | Gradient; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * A separate color for the negative part of the area. * @since 3.0 @@ -4742,6 +4750,10 @@ declare namespace Highcharts { * @since 2.3.0 */ grouping?: boolean; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; /** * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the * columns from becoming too wide when there is a small number of points in the chart. @@ -4749,6 +4761,10 @@ declare namespace Highcharts { * @since 4.1.8 */ maxPointWidth?: number | null; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or * close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, @@ -4843,6 +4859,10 @@ declare namespace Highcharts { * @since 3.0 */ displayNegative?: boolean; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; /** * Maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of * each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width @@ -4851,6 +4871,10 @@ declare namespace Highcharts { * @since 3.0 */ maxSize?: string | number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * Minimum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of * each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width @@ -5136,6 +5160,14 @@ declare namespace Highcharts { * Options for the dial or arrow pointer of the gauge. */ dial?: Dial; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * Allow the dial to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 * to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis. Defaults to 0. @@ -5204,6 +5236,10 @@ declare namespace Highcharts { * @default 50 */ cropTreshold?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; /** * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the * columns from becoming too wide when there is a small number of points in the chart. @@ -5211,6 +5247,10 @@ declare namespace Highcharts { * @since 4.1.8 */ maxPointWidth?: number | null; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * The row size - how many Y axis units each heatmap row should span. * @default 1 @@ -5229,6 +5269,14 @@ declare namespace Highcharts { } interface LineChart extends SeriesChart { + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * Whether to apply steps to the line. Possible values are left, center and right. Prior to 2.3.5, only left was * supported. @@ -5299,6 +5347,14 @@ declare namespace Highcharts { * @since 2.0 */ innerSize?: number | string; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels * in side the plot area, but only to this size. @@ -5346,6 +5402,14 @@ declare namespace Highcharts { * @default 0 */ lineWidth?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; } interface PyramidChart extends SeriesChart { @@ -5420,7 +5484,16 @@ declare namespace Highcharts { width?: number | string; } - interface ScatterChart extends SeriesChart { } + interface ScatterChart extends SeriesChart { + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; + } /** * A gauge showing values using a filled arc with colors indicating the value. The solid gauge plots values against the @@ -5456,7 +5529,16 @@ declare namespace Highcharts { wrap?: boolean; } - interface SplineChart extends SeriesChart { } + interface SplineChart extends SeriesChart { + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; + } /** * The size of the point shape is determined by its value relative to its siblings values. Requires the module @@ -5528,6 +5610,10 @@ declare namespace Highcharts { * Set options on specific levels. Takes precedence over series options, but not point options. */ levels?: TreeMapLevel[]; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; /** * The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the * columns from becoming too wide when there is a small number of points in the chart. @@ -5535,6 +5621,10 @@ declare namespace Highcharts { * @since 4.1.8 */ maxPointWidth?: number | null; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * The sort index of the point inside the treemap level. * @since 4.1.10 @@ -5599,6 +5689,14 @@ declare namespace Highcharts { * @since 5.0.12 */ exposeElementToA11y?: boolean; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * This option decides which algorithm is used for placement, and rotation of a word. The choice of algorith is * therefore a crucial part of the resulting layout of the wordcloud. It is possible for users to add their own @@ -5799,6 +5897,14 @@ declare namespace Highcharts { * The sequential index of the series in the legend. */ legendIndex?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + maxFontSize?: number; + /** + * For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series. + */ + minFontSize?: number; /** * The name of the series as shown in the legend, tooltip etc. */ From 7cda494c6987dec64f6ceb59dccb14341d3ea49f Mon Sep 17 00:00:00 2001 From: juwar Date: Mon, 22 Oct 2018 09:21:02 -0700 Subject: [PATCH 014/799] Update version at top of file. --- types/highcharts/index.d.ts | 334 +++++++++++++++++++++++++++--------- 1 file changed, 255 insertions(+), 79 deletions(-) diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index d3036a869a..7da3ac752d 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Highcharts 5.0.13 +// Type definitions for Highcharts 5.0.32 // Project: http://www.highcharts.com/ // Definitions by: Damiano Gambarotto // Dan Lewi Harkestad @@ -292,7 +292,7 @@ declare namespace Highcharts { * @default null * @since 2.3 */ - innerRadius?: number | string | null; + innerRadius?: number | string | null; /** * Text labels for the plot bands */ @@ -494,12 +494,12 @@ declare namespace Highcharts { shadow?: | boolean | { - color?: string | Gradient; - offsetX?: number; - offsetY?: number; - opacity?: number; - width?: number; - }; + color?: string | Gradient; + offsetX?: number; + offsetY?: number; + opacity?: number; + width?: number; + }; /** * The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object. * @default "callout" @@ -1294,7 +1294,7 @@ declare namespace Highcharts { * Use this in cases where a linear gradient between a minColor and maxColor is not sufficient. * The stops is an array of tuples, where the first item is a float between 0 and 1 assigning the relative position in the gradient, and the second item is the color. */ - stops?: Array>; + stops?: Array>; /** * The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within * a chart. This option overrides the tickPixelInterval option. @@ -1859,7 +1859,9 @@ declare namespace Highcharts { interface Gradient { linearGradient?: LinearGradient | number[]; radialGradient?: { - cx: number; cy: number; r: number; + cx: number; + cy: number; + r: number; }; stops?: any[][]; /** @@ -2015,7 +2017,7 @@ declare namespace Highcharts { /** * The button stroke width */ - 'stroke-width'?: number; + "stroke-width"?: number; /** * The border radius */ @@ -3416,7 +3418,7 @@ declare namespace Highcharts { * @default ['50%', '50%'] * @since 2.3.0 */ - center?: Array; + center?: Array; /** * The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. * @default startAngle + 360 @@ -4033,7 +4035,7 @@ declare namespace Highcharts { halo?: boolean | Halo; } - interface PieStates extends BarStates, LineStates { } + interface PieStates extends BarStates, LineStates {} interface AreaZone { /** @@ -4682,11 +4684,9 @@ declare namespace Highcharts { dataLabels?: RangeDataLabels; } - interface AreaSplineChart extends AreaChart { - } + interface AreaSplineChart extends AreaChart {} - interface AreaSplineRangeChart extends AreaRangeChart { - } + interface AreaSplineRangeChart extends AreaRangeChart {} interface BarChart extends SeriesChart { /** @@ -4925,8 +4925,7 @@ declare namespace Highcharts { zThreshold?: number; } - interface ColumnChart extends BarChart { - } + interface ColumnChart extends BarChart {} /** * The column range is a cartesian series type with higher and lower Y values along an X axis. Requires @@ -5874,7 +5873,14 @@ declare namespace Highcharts { * [3, 7, 8] * */ - data?: Array; + data?: Array< + | number + | [number, number] + | [string, number] + | [string, number, number] + | [number, number, number] + | DataPoint + >; /** * A description of the series to add to the screen reader information about the series. * @since 5.0.0 @@ -5942,31 +5948,73 @@ declare namespace Highcharts { zIndex?: number; } - interface SeriesOptions extends IndividualSeriesOptions, SeriesChart { } + interface SeriesOptions extends IndividualSeriesOptions, SeriesChart {} - interface AreaChartSeriesOptions extends IndividualSeriesOptions, AreaChart { } - interface AreaRangeChartSeriesOptions extends IndividualSeriesOptions, AreaRangeChart { } - interface AreaSplineChartSeriesOptions extends IndividualSeriesOptions, AreaSplineChart { } - interface AreaSplineRangeChartSeriesOptions extends IndividualSeriesOptions, AreaSplineRangeChart { } - interface BarChartSeriesOptions extends IndividualSeriesOptions, BarChart { } - interface BoxPlotChartSeriesOptions extends IndividualSeriesOptions, BoxPlotChart { } - interface BubbleChartSeriesOptions extends IndividualSeriesOptions, BubbleChart { } - interface ColumnChartSeriesOptions extends IndividualSeriesOptions, ColumnChart { } - interface ColumnRangeChartSeriesOptions extends IndividualSeriesOptions, ColumnRangeChart { } - interface ErrorBarChartSeriesOptions extends IndividualSeriesOptions, ErrorBarChart { } - interface FunnelChartSeriesOptions extends IndividualSeriesOptions, FunnelChart { } - interface GaugeChartSeriesOptions extends IndividualSeriesOptions, GaugeChart { } - interface HeatMapSeriesOptions extends IndividualSeriesOptions, HeatMapChart { } - interface LineChartSeriesOptions extends IndividualSeriesOptions, LineChart { } - interface PieChartSeriesOptions extends IndividualSeriesOptions, PieChart { } - interface PolygonChartSeriesOptions extends IndividualSeriesOptions, PolygonChart { } - interface PyramidChartSeriesOptions extends IndividualSeriesOptions, PyramidChart { } - interface ScatterChartSeriesOptions extends IndividualSeriesOptions, ScatterChart { } - interface SolidGaugeChartSeriesOptions extends IndividualSeriesOptions, SolidGaugeChart { } - interface SplineChartSeriesOptions extends IndividualSeriesOptions, SplineChart { } - interface TreeMapChartSeriesOptions extends IndividualSeriesOptions, TreeMapChart { } - interface WaterFallChartSeriesOptions extends IndividualSeriesOptions, WaterFallChart { } - interface WordCloudChartSeriesOptions extends IndividualSeriesOptions, WordCloudChart { } + interface AreaChartSeriesOptions + extends IndividualSeriesOptions, + AreaChart {} + interface AreaRangeChartSeriesOptions + extends IndividualSeriesOptions, + AreaRangeChart {} + interface AreaSplineChartSeriesOptions + extends IndividualSeriesOptions, + AreaSplineChart {} + interface AreaSplineRangeChartSeriesOptions + extends IndividualSeriesOptions, + AreaSplineRangeChart {} + interface BarChartSeriesOptions extends IndividualSeriesOptions, BarChart {} + interface BoxPlotChartSeriesOptions + extends IndividualSeriesOptions, + BoxPlotChart {} + interface BubbleChartSeriesOptions + extends IndividualSeriesOptions, + BubbleChart {} + interface ColumnChartSeriesOptions + extends IndividualSeriesOptions, + ColumnChart {} + interface ColumnRangeChartSeriesOptions + extends IndividualSeriesOptions, + ColumnRangeChart {} + interface ErrorBarChartSeriesOptions + extends IndividualSeriesOptions, + ErrorBarChart {} + interface FunnelChartSeriesOptions + extends IndividualSeriesOptions, + FunnelChart {} + interface GaugeChartSeriesOptions + extends IndividualSeriesOptions, + GaugeChart {} + interface HeatMapSeriesOptions + extends IndividualSeriesOptions, + HeatMapChart {} + interface LineChartSeriesOptions + extends IndividualSeriesOptions, + LineChart {} + interface PieChartSeriesOptions extends IndividualSeriesOptions, PieChart {} + interface PolygonChartSeriesOptions + extends IndividualSeriesOptions, + PolygonChart {} + interface PyramidChartSeriesOptions + extends IndividualSeriesOptions, + PyramidChart {} + interface ScatterChartSeriesOptions + extends IndividualSeriesOptions, + ScatterChart {} + interface SolidGaugeChartSeriesOptions + extends IndividualSeriesOptions, + SolidGaugeChart {} + interface SplineChartSeriesOptions + extends IndividualSeriesOptions, + SplineChart {} + interface TreeMapChartSeriesOptions + extends IndividualSeriesOptions, + TreeMapChart {} + interface WaterFallChartSeriesOptions + extends IndividualSeriesOptions, + WaterFallChart {} + interface WordCloudChartSeriesOptions + extends IndividualSeriesOptions, + WordCloudChart {} interface DataPoint { /** @@ -6321,7 +6369,12 @@ declare namespace Highcharts { * * @default null */ - crosshairs?: boolean | [boolean, boolean] | CrosshairObject | [CrosshairObject, CrosshairObject] | null; + crosshairs?: + | boolean + | [boolean, boolean] + | CrosshairObject + | [CrosshairObject, CrosshairObject] + | null; /** * Enable or disable the tooltip. * @default true @@ -6380,7 +6433,11 @@ declare namespace Highcharts { * The return should be an object containing x and y values, for example { x: 100, y: 100 }. * @since 2.2.4 */ - positioner?(labelWidth: number, labelHeight: number, point: PlotPoint): { x: number; y: number; }; + positioner?( + labelWidth: number, + labelHeight: number, + point: PlotPoint + ): { x: number; y: number }; /** * Whether to apply a drop shadow to the tooltip. * @default true @@ -6751,7 +6808,13 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - setExtremes(min?: number, max?: number, redraw?: boolean, animation?: boolean | Animation, eventArguments?: any): void; + setExtremes( + min?: number, + max?: number, + redraw?: boolean, + animation?: boolean | Animation, + eventArguments?: any + ): void; /** * Update the title of the axis after render time. * @param title The new title options on the same format as given in xAxis.title. @@ -6800,7 +6863,12 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 3.0 */ - addAxis(options: AxisOptions, isX?: boolean, redraw?: boolean, animation?: boolean | Animation): AxisObject; + addAxis( + options: AxisOptions, + isX?: boolean, + redraw?: boolean, + animation?: boolean | Animation + ): AxisObject; /** * Set a new credits label for the chart. * @param A configuration object for the credits as defined at credits. @@ -6815,7 +6883,11 @@ declare namespace Highcharts { * @param [boolean] redraw * @since 1.2.0 */ - addSeries(options: T, redraw?: boolean, animation?: boolean | Animation): SeriesObject; + addSeries( + options: T, + redraw?: boolean, + animation?: boolean | Animation + ): SeriesObject; /** * Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async * drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution @@ -6824,7 +6896,10 @@ declare namespace Highcharts { * @param seriesOptions The series options, as documented under plotOptions.series and under the plotOptions for each series type. * @since 3.0.8 */ - addSeriesAsDrilldown(point: PointObject, seriesOptions: IndividualSeriesOptions): void; + addSeriesAsDrilldown( + point: PointObject, + seriesOptions: IndividualSeriesOptions + ): void; chartHeight?: number; chartWidth?: number; /** @@ -6898,7 +6973,10 @@ declare namespace Highcharts { * exported chart. Same as the exportChart params. * @since 2.0 */ - exportChartLocal(options: ExportingOptions, chartOptions: Options): void; + exportChartLocal( + options: ExportingOptions, + chartOptions: Options + ): void; /** * Get an axis, series or point by its id as given in the configuration options. * @param id The id of the axis, series or point to get. @@ -6975,7 +7053,11 @@ declare namespace Highcharts { * @param animation Defaults to true. When true, the resize will be animated with default animation options. * The animation can also be a configuration object with properties duration and easing. */ - setSize(width: number, height: number, animation?: boolean | Animation): void; + setSize( + width: number, + height: number, + animation?: boolean | Animation + ): void; /** * Set a new title or subtitle for the chart * @param title A configuration object for the new title as defined at #title. @@ -6983,7 +7065,11 @@ declare namespace Highcharts { * @param [boolean] redraw Whether to redraw the chart. Defaults to true. * @since 2.1.0 */ - setTitle(title: TitleOptions, subtitle?: SubtitleOptions, redraw?: boolean): void; + setTitle( + title: TitleOptions, + subtitle?: SubtitleOptions, + redraw?: boolean + ): void; /** * Dim the chart's plot area and show a loading label text. Options for the loading screen are defined at * options.loading. A custom text can be given as a parameter for loading. @@ -7015,7 +7101,12 @@ declare namespace Highcharts { * @param [(boolean | AnimationOptions)] animation Whether to apply animation, and optionally animation configuration. * @since 5.0.0 */ - update(options: Options, redraw?: boolean, oneToOne?: boolean, animation?: boolean | AnimationOptions): void; + update( + options: Options, + redraw?: boolean, + oneToOne?: boolean, + animation?: boolean | AnimationOptions + ): void; /** * This method is deprecated as of 2.0.1. Updating the chart position after a move operation is no longer necessary. * @since 1.2.5 @@ -7052,7 +7143,10 @@ declare namespace Highcharts { * and in these cases the chart object will not be finished directly after callingnew Highcharts.Chart(). * s a consequence, code that relies on the newly built Chart object should always run in the callback. Defining a chart.event.load handler is equivalent. */ - new (options: Options, callback: (chart: ChartObject) => void): ChartObject; + new ( + options: Options, + callback: (chart: ChartObject) => void + ): ChartObject; /** * This is the constructor for creating a new chart object. * @param renderTo The id or a reference to a DOM element where the chart should be rendered (since v4.2.0). @@ -7068,7 +7162,11 @@ declare namespace Highcharts { * and in these cases the chart object will not be finished directly after callingnew Highcharts.Chart(). * As a consequence, code that relies on the newly built Chart object should always run in the callback. Defining a chart.event.load handler is equivalent. */ - new (renderTo: string | HTMLElement, options: Options, callback: (chart: ChartObject) => void): ChartObject; + new ( + renderTo: string | HTMLElement, + options: Options, + callback: (chart: ChartObject) => void + ): ChartObject; } /** @@ -7121,7 +7219,7 @@ declare namespace Highcharts { * @return An object containing x, y, width and height values for the element. * @since 2.0 */ - getBBox(): { x: number; y: number; height: number; width: number; }; + getBBox(): { x: number; y: number; height: number; width: number }; /** * Apply an event handler to the element * @param eventType The event type to attach, for example 'click', 'mouseover', 'touch'. @@ -7160,7 +7258,14 @@ declare namespace Highcharts { * @param end The ending angle of the arc in radians, where 0 is to the right and -Math.PI/2 is up. * @since 2.0 */ - arc(centerX: number, centerY: number, outerRadius: number, innerRadius: number, start: number, end: number): ElementObject; + arc( + centerX: number, + centerY: number, + outerRadius: number, + innerRadius: number, + start: number, + end: number + ): ElementObject; /** * Draw circle on the renderer canvas. * @param centerX The x position of the circle's center in the SVG element. @@ -7200,7 +7305,13 @@ declare namespace Highcharts { * @param height The height of the image. * @since 2.0 */ - image(source: string, x: number, y: number, width: number, height: number): ElementObject; + image( + source: string, + x: number, + y: number, + width: number, + height: number + ): ElementObject; /** * Draw a label, which is an extended text element with support for border and background. Highcharts creates a g * element with a text and a path or rect inside, to make it behave somewhat like a HTML div. Border and background @@ -7218,7 +7329,17 @@ declare namespace Highcharts { * @param [string] className A class name for the g element surrounding the label. * @since 2.0 */ - label(str: string, x: number, y: number, shape?: string, anchorX?: number, anchorY?: number, useHTML?: boolean, baseline?: boolean, className?: string): ElementObject; + label( + str: string, + x: number, + y: number, + shape?: string, + anchorX?: number, + anchorY?: number, + useHTML?: boolean, + baseline?: boolean, + className?: string + ): ElementObject; /** * Add a path based on SVG's path commands. In SVG capable browsers all path commands are supported, but in VML only * a subset is supported: absolute moveTo (M), absolute lineTo (L), absolute curveTo (C) and close (Z). @@ -7234,7 +7355,13 @@ declare namespace Highcharts { * @param cornerRadius The corner radius of all the rectangle's corners. * @since 2.0 */ - rect(x: number, y: number, width: number, height: number, cornerRadius: number): ElementObject; + rect( + x: number, + y: number, + width: number, + height: number, + cornerRadius: number + ): ElementObject; /** * Draw text. The text can contain a subset of HTML, like spans and anchors and some basic text styling of these. * For more advanced features like border and background, use label instead. @@ -7262,7 +7389,11 @@ declare namespace Highcharts { } interface Renderer { - new (parentNode: HTMLElement, width: number, height: number): RendererObject; + new ( + parentNode: HTMLElement, + width: number, + height: number + ): RendererObject; } interface Static { @@ -7274,12 +7405,19 @@ declare namespace Highcharts { * As Highcharts.Chart, but without need for the new keyword. * @since 4.2.0 */ - chart(options: Options, callback?: (chart: ChartObject) => void): ChartObject; + chart( + options: Options, + callback?: (chart: ChartObject) => void + ): ChartObject; /** * As Highcharts.Chart, but without need for the new keyword. * @since 4.2.0 */ - chart(renderTo: string | HTMLElement, options: Options, callback?: (chart: ChartObject) => void): ChartObject; + chart( + renderTo: string | HTMLElement, + options: Options, + callback?: (chart: ChartObject) => void + ): ChartObject; /** * An array containing the current chart objects in the page. A chart's position in the array is preserved * throughout the page's lifetime. When a chart is destroyed, the array item becomes undefined. @@ -7318,7 +7456,12 @@ declare namespace Highcharts { * @param decimalPoint The decimal point. Defaults to '.' or to the string specified globally in options.lang.decimalPoint. * @param thousandsSep The thousands separator. Defaults to ' ' or to the string specified globally in options.lang.thousandsSep. */ - numberFormat(value: number, decimals?: number, decimalPoint?: string, thousandsSep?: string): string; + numberFormat( + value: number, + decimals?: number, + decimalPoint?: string, + thousandsSep?: string + ): string; /** * Sets the options globally for all charts created after this has been called. Takes an options JavaScript object * structure as the argument. These options are merged with the default options and the result is returned. @@ -7343,7 +7486,11 @@ declare namespace Highcharts { * @param type The type of behavior you are extending. * @param cb The function that executes when the behavior occurs. */ - wrap(prototype: any, type: string, cb: (proceed: Function, ...args: any[]) => void): void; + wrap( + prototype: any, + type: string, + cb: (proceed: Function, ...args: any[]) => void + ): void; /** * Add an event listener. @@ -7356,9 +7503,11 @@ declare namespace Highcharts { * @param cb The function callback to execute when the event is fired. * @returns A callback function to remove the added event. */ - addEvent(element: HTMLElement | ElementObject | object, - type: string, - cb: (evt: Event) => void): () => void; + addEvent( + element: HTMLElement | ElementObject | object, + type: string, + cb: (evt: Event) => void + ): () => void; /** * Fire an event that was registered with @@ -7370,10 +7519,12 @@ declare namespace Highcharts { * @param eventArguments Custom event arguments that are passed on as an argument to the event handler. * @param defaultFunction The default function to execute if the other listeners haven't returned false. */ - fireEvent(element: HTMLElement | ElementObject | object, - type: string, - eventArguments?: any, - defaultFunction?: () => void): void; + fireEvent( + element: HTMLElement | ElementObject | object, + type: string, + eventArguments?: any, + defaultFunction?: () => void + ): void; distribute(array: any[], value: number): void; @@ -7443,7 +7594,11 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - slice(sliced?: boolean, redraw?: boolean, animation?: boolean | Animation): void; + slice( + sliced?: boolean, + redraw?: boolean, + animation?: boolean | Animation + ): void; /** * The total of a stack for stacked series, or pie in pie charts. */ @@ -7459,7 +7614,11 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - update(options: number | [number, number] | DataPoint, redraw?: boolean, animation?: boolean | Animation): void; + update( + options: number | [number, number] | DataPoint, + redraw?: boolean, + animation?: boolean | Animation + ): void; /** * The x value for the point. * @since 1.2.0 @@ -7500,7 +7659,12 @@ declare namespace Highcharts { * Use this option for live charts monitoring a value over time. * @since 1.2.0 */ - addPoint(options: number | [number, number] | DataPoint, redraw?: boolean, shift?: boolean, animation?: boolean | Animation): void; + addPoint( + options: number | [number, number] | DataPoint, + redraw?: boolean, + shift?: boolean, + animation?: boolean | Animation + ): void; /** * Read only. The chart that the series belongs to. * @since 1.2.0 @@ -7544,7 +7708,11 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 4.1.0 */ - removePoint(index: number, redraw?: boolean, animation?: boolean | Animation): void; + removePoint( + index: number, + redraw?: boolean, + animation?: boolean | Animation + ): void; /** * Select or unselect the series. This means its selected property is set,the checkbox in the legend is toggled and * when selected, the series is returned in the chart.getSelectedSeries() method. @@ -7569,7 +7737,12 @@ declare namespace Highcharts { * This option prevents this, and makes setData behave like it did prior to Highcharts 3.0.10. * @since 1.2.0 */ - setData(data: number[] | number[][] | DataPoint[], redraw?: boolean, animation?: boolean | Animation, updatePoints?: boolean): void; + setData( + data: number[] | number[][] | DataPoint[], + redraw?: boolean, + animation?: boolean | Animation, + updatePoints?: boolean + ): void; /** * A utility function to show or hide the series with an optional redraw. * @param [boolean] visible - Whether to show or hide the series. If undefined, the visibility is toggled. @@ -7656,7 +7829,10 @@ declare global { * @param callback Callback function used to manipulate the constructed chart instance * @return current {JQuery} selector the current JQuery selector */ - highcharts(options: Highcharts.Options, callback: (chart: Highcharts.ChartObject) => void): JQuery; + highcharts( + options: Highcharts.Options, + callback: (chart: Highcharts.ChartObject) => void + ): JQuery; } } From 2083505b395c2742083e085386ea96a503eb70af Mon Sep 17 00:00:00 2001 From: juwar Date: Mon, 22 Oct 2018 09:31:35 -0700 Subject: [PATCH 015/799] Revert the formatting --- types/highcharts/index.d.ts | 332 +++++++++--------------------------- 1 file changed, 78 insertions(+), 254 deletions(-) diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index 7da3ac752d..644dc1a169 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -292,7 +292,7 @@ declare namespace Highcharts { * @default null * @since 2.3 */ - innerRadius?: number | string | null; + innerRadius?: number | string | null; /** * Text labels for the plot bands */ @@ -494,12 +494,12 @@ declare namespace Highcharts { shadow?: | boolean | { - color?: string | Gradient; - offsetX?: number; - offsetY?: number; - opacity?: number; - width?: number; - }; + color?: string | Gradient; + offsetX?: number; + offsetY?: number; + opacity?: number; + width?: number; + }; /** * The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object. * @default "callout" @@ -1294,7 +1294,7 @@ declare namespace Highcharts { * Use this in cases where a linear gradient between a minColor and maxColor is not sufficient. * The stops is an array of tuples, where the first item is a float between 0 and 1 assigning the relative position in the gradient, and the second item is the color. */ - stops?: Array>; + stops?: Array>; /** * The amount of ticks to draw on the axis. This opens up for aligning the ticks of multiple charts or panes within * a chart. This option overrides the tickPixelInterval option. @@ -1859,9 +1859,7 @@ declare namespace Highcharts { interface Gradient { linearGradient?: LinearGradient | number[]; radialGradient?: { - cx: number; - cy: number; - r: number; + cx: number; cy: number; r: number; }; stops?: any[][]; /** @@ -2017,7 +2015,7 @@ declare namespace Highcharts { /** * The button stroke width */ - "stroke-width"?: number; + 'stroke-width'?: number; /** * The border radius */ @@ -3418,7 +3416,7 @@ declare namespace Highcharts { * @default ['50%', '50%'] * @since 2.3.0 */ - center?: Array; + center?: Array; /** * The end angle of the polar X axis or gauge value axis, given in degrees where 0 is north. * @default startAngle + 360 @@ -4035,7 +4033,7 @@ declare namespace Highcharts { halo?: boolean | Halo; } - interface PieStates extends BarStates, LineStates {} + interface PieStates extends BarStates, LineStates { } interface AreaZone { /** @@ -4684,9 +4682,11 @@ declare namespace Highcharts { dataLabels?: RangeDataLabels; } - interface AreaSplineChart extends AreaChart {} + interface AreaSplineChart extends AreaChart { + } - interface AreaSplineRangeChart extends AreaRangeChart {} + interface AreaSplineRangeChart extends AreaRangeChart { + } interface BarChart extends SeriesChart { /** @@ -4925,7 +4925,8 @@ declare namespace Highcharts { zThreshold?: number; } - interface ColumnChart extends BarChart {} + interface ColumnChart extends BarChart { + } /** * The column range is a cartesian series type with higher and lower Y values along an X axis. Requires @@ -5873,14 +5874,7 @@ declare namespace Highcharts { * [3, 7, 8] * */ - data?: Array< - | number - | [number, number] - | [string, number] - | [string, number, number] - | [number, number, number] - | DataPoint - >; + data?: Array; /** * A description of the series to add to the screen reader information about the series. * @since 5.0.0 @@ -5948,73 +5942,31 @@ declare namespace Highcharts { zIndex?: number; } - interface SeriesOptions extends IndividualSeriesOptions, SeriesChart {} + interface SeriesOptions extends IndividualSeriesOptions, SeriesChart { } - interface AreaChartSeriesOptions - extends IndividualSeriesOptions, - AreaChart {} - interface AreaRangeChartSeriesOptions - extends IndividualSeriesOptions, - AreaRangeChart {} - interface AreaSplineChartSeriesOptions - extends IndividualSeriesOptions, - AreaSplineChart {} - interface AreaSplineRangeChartSeriesOptions - extends IndividualSeriesOptions, - AreaSplineRangeChart {} - interface BarChartSeriesOptions extends IndividualSeriesOptions, BarChart {} - interface BoxPlotChartSeriesOptions - extends IndividualSeriesOptions, - BoxPlotChart {} - interface BubbleChartSeriesOptions - extends IndividualSeriesOptions, - BubbleChart {} - interface ColumnChartSeriesOptions - extends IndividualSeriesOptions, - ColumnChart {} - interface ColumnRangeChartSeriesOptions - extends IndividualSeriesOptions, - ColumnRangeChart {} - interface ErrorBarChartSeriesOptions - extends IndividualSeriesOptions, - ErrorBarChart {} - interface FunnelChartSeriesOptions - extends IndividualSeriesOptions, - FunnelChart {} - interface GaugeChartSeriesOptions - extends IndividualSeriesOptions, - GaugeChart {} - interface HeatMapSeriesOptions - extends IndividualSeriesOptions, - HeatMapChart {} - interface LineChartSeriesOptions - extends IndividualSeriesOptions, - LineChart {} - interface PieChartSeriesOptions extends IndividualSeriesOptions, PieChart {} - interface PolygonChartSeriesOptions - extends IndividualSeriesOptions, - PolygonChart {} - interface PyramidChartSeriesOptions - extends IndividualSeriesOptions, - PyramidChart {} - interface ScatterChartSeriesOptions - extends IndividualSeriesOptions, - ScatterChart {} - interface SolidGaugeChartSeriesOptions - extends IndividualSeriesOptions, - SolidGaugeChart {} - interface SplineChartSeriesOptions - extends IndividualSeriesOptions, - SplineChart {} - interface TreeMapChartSeriesOptions - extends IndividualSeriesOptions, - TreeMapChart {} - interface WaterFallChartSeriesOptions - extends IndividualSeriesOptions, - WaterFallChart {} - interface WordCloudChartSeriesOptions - extends IndividualSeriesOptions, - WordCloudChart {} + interface AreaChartSeriesOptions extends IndividualSeriesOptions, AreaChart { } + interface AreaRangeChartSeriesOptions extends IndividualSeriesOptions, AreaRangeChart { } + interface AreaSplineChartSeriesOptions extends IndividualSeriesOptions, AreaSplineChart { } + interface AreaSplineRangeChartSeriesOptions extends IndividualSeriesOptions, AreaSplineRangeChart { } + interface BarChartSeriesOptions extends IndividualSeriesOptions, BarChart { } + interface BoxPlotChartSeriesOptions extends IndividualSeriesOptions, BoxPlotChart { } + interface BubbleChartSeriesOptions extends IndividualSeriesOptions, BubbleChart { } + interface ColumnChartSeriesOptions extends IndividualSeriesOptions, ColumnChart { } + interface ColumnRangeChartSeriesOptions extends IndividualSeriesOptions, ColumnRangeChart { } + interface ErrorBarChartSeriesOptions extends IndividualSeriesOptions, ErrorBarChart { } + interface FunnelChartSeriesOptions extends IndividualSeriesOptions, FunnelChart { } + interface GaugeChartSeriesOptions extends IndividualSeriesOptions, GaugeChart { } + interface HeatMapSeriesOptions extends IndividualSeriesOptions, HeatMapChart { } + interface LineChartSeriesOptions extends IndividualSeriesOptions, LineChart { } + interface PieChartSeriesOptions extends IndividualSeriesOptions, PieChart { } + interface PolygonChartSeriesOptions extends IndividualSeriesOptions, PolygonChart { } + interface PyramidChartSeriesOptions extends IndividualSeriesOptions, PyramidChart { } + interface ScatterChartSeriesOptions extends IndividualSeriesOptions, ScatterChart { } + interface SolidGaugeChartSeriesOptions extends IndividualSeriesOptions, SolidGaugeChart { } + interface SplineChartSeriesOptions extends IndividualSeriesOptions, SplineChart { } + interface TreeMapChartSeriesOptions extends IndividualSeriesOptions, TreeMapChart { } + interface WaterFallChartSeriesOptions extends IndividualSeriesOptions, WaterFallChart { } + interface WordCloudChartSeriesOptions extends IndividualSeriesOptions, WordCloudChart { } interface DataPoint { /** @@ -6369,12 +6321,7 @@ declare namespace Highcharts { * * @default null */ - crosshairs?: - | boolean - | [boolean, boolean] - | CrosshairObject - | [CrosshairObject, CrosshairObject] - | null; + crosshairs?: boolean | [boolean, boolean] | CrosshairObject | [CrosshairObject, CrosshairObject] | null; /** * Enable or disable the tooltip. * @default true @@ -6433,11 +6380,7 @@ declare namespace Highcharts { * The return should be an object containing x and y values, for example { x: 100, y: 100 }. * @since 2.2.4 */ - positioner?( - labelWidth: number, - labelHeight: number, - point: PlotPoint - ): { x: number; y: number }; + positioner?(labelWidth: number, labelHeight: number, point: PlotPoint): { x: number; y: number; }; /** * Whether to apply a drop shadow to the tooltip. * @default true @@ -6808,13 +6751,7 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - setExtremes( - min?: number, - max?: number, - redraw?: boolean, - animation?: boolean | Animation, - eventArguments?: any - ): void; + setExtremes(min?: number, max?: number, redraw?: boolean, animation?: boolean | Animation, eventArguments?: any): void; /** * Update the title of the axis after render time. * @param title The new title options on the same format as given in xAxis.title. @@ -6863,12 +6800,7 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 3.0 */ - addAxis( - options: AxisOptions, - isX?: boolean, - redraw?: boolean, - animation?: boolean | Animation - ): AxisObject; + addAxis(options: AxisOptions, isX?: boolean, redraw?: boolean, animation?: boolean | Animation): AxisObject; /** * Set a new credits label for the chart. * @param A configuration object for the credits as defined at credits. @@ -6883,11 +6815,7 @@ declare namespace Highcharts { * @param [boolean] redraw * @since 1.2.0 */ - addSeries( - options: T, - redraw?: boolean, - animation?: boolean | Animation - ): SeriesObject; + addSeries(options: T, redraw?: boolean, animation?: boolean | Animation): SeriesObject; /** * Add a series to the chart as drilldown from a specific point in the parent series. This method is used for async * drilldown, when clicking a point in a series should result in loading and displaying a more high-resolution @@ -6896,10 +6824,7 @@ declare namespace Highcharts { * @param seriesOptions The series options, as documented under plotOptions.series and under the plotOptions for each series type. * @since 3.0.8 */ - addSeriesAsDrilldown( - point: PointObject, - seriesOptions: IndividualSeriesOptions - ): void; + addSeriesAsDrilldown(point: PointObject, seriesOptions: IndividualSeriesOptions): void; chartHeight?: number; chartWidth?: number; /** @@ -6973,10 +6898,7 @@ declare namespace Highcharts { * exported chart. Same as the exportChart params. * @since 2.0 */ - exportChartLocal( - options: ExportingOptions, - chartOptions: Options - ): void; + exportChartLocal(options: ExportingOptions, chartOptions: Options): void; /** * Get an axis, series or point by its id as given in the configuration options. * @param id The id of the axis, series or point to get. @@ -7053,11 +6975,7 @@ declare namespace Highcharts { * @param animation Defaults to true. When true, the resize will be animated with default animation options. * The animation can also be a configuration object with properties duration and easing. */ - setSize( - width: number, - height: number, - animation?: boolean | Animation - ): void; + setSize(width: number, height: number, animation?: boolean | Animation): void; /** * Set a new title or subtitle for the chart * @param title A configuration object for the new title as defined at #title. @@ -7065,11 +6983,7 @@ declare namespace Highcharts { * @param [boolean] redraw Whether to redraw the chart. Defaults to true. * @since 2.1.0 */ - setTitle( - title: TitleOptions, - subtitle?: SubtitleOptions, - redraw?: boolean - ): void; + setTitle(title: TitleOptions, subtitle?: SubtitleOptions, redraw?: boolean): void; /** * Dim the chart's plot area and show a loading label text. Options for the loading screen are defined at * options.loading. A custom text can be given as a parameter for loading. @@ -7101,12 +7015,7 @@ declare namespace Highcharts { * @param [(boolean | AnimationOptions)] animation Whether to apply animation, and optionally animation configuration. * @since 5.0.0 */ - update( - options: Options, - redraw?: boolean, - oneToOne?: boolean, - animation?: boolean | AnimationOptions - ): void; + update(options: Options, redraw?: boolean, oneToOne?: boolean, animation?: boolean | AnimationOptions): void; /** * This method is deprecated as of 2.0.1. Updating the chart position after a move operation is no longer necessary. * @since 1.2.5 @@ -7143,10 +7052,7 @@ declare namespace Highcharts { * and in these cases the chart object will not be finished directly after callingnew Highcharts.Chart(). * s a consequence, code that relies on the newly built Chart object should always run in the callback. Defining a chart.event.load handler is equivalent. */ - new ( - options: Options, - callback: (chart: ChartObject) => void - ): ChartObject; + new (options: Options, callback: (chart: ChartObject) => void): ChartObject; /** * This is the constructor for creating a new chart object. * @param renderTo The id or a reference to a DOM element where the chart should be rendered (since v4.2.0). @@ -7162,11 +7068,7 @@ declare namespace Highcharts { * and in these cases the chart object will not be finished directly after callingnew Highcharts.Chart(). * As a consequence, code that relies on the newly built Chart object should always run in the callback. Defining a chart.event.load handler is equivalent. */ - new ( - renderTo: string | HTMLElement, - options: Options, - callback: (chart: ChartObject) => void - ): ChartObject; + new (renderTo: string | HTMLElement, options: Options, callback: (chart: ChartObject) => void): ChartObject; } /** @@ -7219,7 +7121,7 @@ declare namespace Highcharts { * @return An object containing x, y, width and height values for the element. * @since 2.0 */ - getBBox(): { x: number; y: number; height: number; width: number }; + getBBox(): { x: number; y: number; height: number; width: number; }; /** * Apply an event handler to the element * @param eventType The event type to attach, for example 'click', 'mouseover', 'touch'. @@ -7258,14 +7160,7 @@ declare namespace Highcharts { * @param end The ending angle of the arc in radians, where 0 is to the right and -Math.PI/2 is up. * @since 2.0 */ - arc( - centerX: number, - centerY: number, - outerRadius: number, - innerRadius: number, - start: number, - end: number - ): ElementObject; + arc(centerX: number, centerY: number, outerRadius: number, innerRadius: number, start: number, end: number): ElementObject; /** * Draw circle on the renderer canvas. * @param centerX The x position of the circle's center in the SVG element. @@ -7305,13 +7200,7 @@ declare namespace Highcharts { * @param height The height of the image. * @since 2.0 */ - image( - source: string, - x: number, - y: number, - width: number, - height: number - ): ElementObject; + image(source: string, x: number, y: number, width: number, height: number): ElementObject; /** * Draw a label, which is an extended text element with support for border and background. Highcharts creates a g * element with a text and a path or rect inside, to make it behave somewhat like a HTML div. Border and background @@ -7329,17 +7218,7 @@ declare namespace Highcharts { * @param [string] className A class name for the g element surrounding the label. * @since 2.0 */ - label( - str: string, - x: number, - y: number, - shape?: string, - anchorX?: number, - anchorY?: number, - useHTML?: boolean, - baseline?: boolean, - className?: string - ): ElementObject; + label(str: string, x: number, y: number, shape?: string, anchorX?: number, anchorY?: number, useHTML?: boolean, baseline?: boolean, className?: string): ElementObject; /** * Add a path based on SVG's path commands. In SVG capable browsers all path commands are supported, but in VML only * a subset is supported: absolute moveTo (M), absolute lineTo (L), absolute curveTo (C) and close (Z). @@ -7355,13 +7234,7 @@ declare namespace Highcharts { * @param cornerRadius The corner radius of all the rectangle's corners. * @since 2.0 */ - rect( - x: number, - y: number, - width: number, - height: number, - cornerRadius: number - ): ElementObject; + rect(x: number, y: number, width: number, height: number, cornerRadius: number): ElementObject; /** * Draw text. The text can contain a subset of HTML, like spans and anchors and some basic text styling of these. * For more advanced features like border and background, use label instead. @@ -7389,11 +7262,7 @@ declare namespace Highcharts { } interface Renderer { - new ( - parentNode: HTMLElement, - width: number, - height: number - ): RendererObject; + new (parentNode: HTMLElement, width: number, height: number): RendererObject; } interface Static { @@ -7405,19 +7274,12 @@ declare namespace Highcharts { * As Highcharts.Chart, but without need for the new keyword. * @since 4.2.0 */ - chart( - options: Options, - callback?: (chart: ChartObject) => void - ): ChartObject; + chart(options: Options, callback?: (chart: ChartObject) => void): ChartObject; /** * As Highcharts.Chart, but without need for the new keyword. * @since 4.2.0 */ - chart( - renderTo: string | HTMLElement, - options: Options, - callback?: (chart: ChartObject) => void - ): ChartObject; + chart(renderTo: string | HTMLElement, options: Options, callback?: (chart: ChartObject) => void): ChartObject; /** * An array containing the current chart objects in the page. A chart's position in the array is preserved * throughout the page's lifetime. When a chart is destroyed, the array item becomes undefined. @@ -7456,12 +7318,7 @@ declare namespace Highcharts { * @param decimalPoint The decimal point. Defaults to '.' or to the string specified globally in options.lang.decimalPoint. * @param thousandsSep The thousands separator. Defaults to ' ' or to the string specified globally in options.lang.thousandsSep. */ - numberFormat( - value: number, - decimals?: number, - decimalPoint?: string, - thousandsSep?: string - ): string; + numberFormat(value: number, decimals?: number, decimalPoint?: string, thousandsSep?: string): string; /** * Sets the options globally for all charts created after this has been called. Takes an options JavaScript object * structure as the argument. These options are merged with the default options and the result is returned. @@ -7486,11 +7343,7 @@ declare namespace Highcharts { * @param type The type of behavior you are extending. * @param cb The function that executes when the behavior occurs. */ - wrap( - prototype: any, - type: string, - cb: (proceed: Function, ...args: any[]) => void - ): void; + wrap(prototype: any, type: string, cb: (proceed: Function, ...args: any[]) => void): void; /** * Add an event listener. @@ -7503,11 +7356,9 @@ declare namespace Highcharts { * @param cb The function callback to execute when the event is fired. * @returns A callback function to remove the added event. */ - addEvent( - element: HTMLElement | ElementObject | object, - type: string, - cb: (evt: Event) => void - ): () => void; + addEvent(element: HTMLElement | ElementObject | object, + type: string, + cb: (evt: Event) => void): () => void; /** * Fire an event that was registered with @@ -7519,12 +7370,10 @@ declare namespace Highcharts { * @param eventArguments Custom event arguments that are passed on as an argument to the event handler. * @param defaultFunction The default function to execute if the other listeners haven't returned false. */ - fireEvent( - element: HTMLElement | ElementObject | object, - type: string, - eventArguments?: any, - defaultFunction?: () => void - ): void; + fireEvent(element: HTMLElement | ElementObject | object, + type: string, + eventArguments?: any, + defaultFunction?: () => void): void; distribute(array: any[], value: number): void; @@ -7594,11 +7443,7 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - slice( - sliced?: boolean, - redraw?: boolean, - animation?: boolean | Animation - ): void; + slice(sliced?: boolean, redraw?: boolean, animation?: boolean | Animation): void; /** * The total of a stack for stacked series, or pie in pie charts. */ @@ -7614,11 +7459,7 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 1.2.0 */ - update( - options: number | [number, number] | DataPoint, - redraw?: boolean, - animation?: boolean | Animation - ): void; + update(options: number | [number, number] | DataPoint, redraw?: boolean, animation?: boolean | Animation): void; /** * The x value for the point. * @since 1.2.0 @@ -7659,12 +7500,7 @@ declare namespace Highcharts { * Use this option for live charts monitoring a value over time. * @since 1.2.0 */ - addPoint( - options: number | [number, number] | DataPoint, - redraw?: boolean, - shift?: boolean, - animation?: boolean | Animation - ): void; + addPoint(options: number | [number, number] | DataPoint, redraw?: boolean, shift?: boolean, animation?: boolean | Animation): void; /** * Read only. The chart that the series belongs to. * @since 1.2.0 @@ -7708,11 +7544,7 @@ declare namespace Highcharts { * The animation can also be a configuration object with properties duration and easing. * @since 4.1.0 */ - removePoint( - index: number, - redraw?: boolean, - animation?: boolean | Animation - ): void; + removePoint(index: number, redraw?: boolean, animation?: boolean | Animation): void; /** * Select or unselect the series. This means its selected property is set,the checkbox in the legend is toggled and * when selected, the series is returned in the chart.getSelectedSeries() method. @@ -7737,12 +7569,7 @@ declare namespace Highcharts { * This option prevents this, and makes setData behave like it did prior to Highcharts 3.0.10. * @since 1.2.0 */ - setData( - data: number[] | number[][] | DataPoint[], - redraw?: boolean, - animation?: boolean | Animation, - updatePoints?: boolean - ): void; + setData(data: number[] | number[][] | DataPoint[], redraw?: boolean, animation?: boolean | Animation, updatePoints?: boolean): void; /** * A utility function to show or hide the series with an optional redraw. * @param [boolean] visible - Whether to show or hide the series. If undefined, the visibility is toggled. @@ -7829,10 +7656,7 @@ declare global { * @param callback Callback function used to manipulate the constructed chart instance * @return current {JQuery} selector the current JQuery selector */ - highcharts( - options: Highcharts.Options, - callback: (chart: Highcharts.ChartObject) => void - ): JQuery; + highcharts(options: Highcharts.Options, callback: (chart: Highcharts.ChartObject) => void): JQuery; } } From 38983e317ac39a234d6bc4106f7f4d0767211800 Mon Sep 17 00:00:00 2001 From: AzSiAz Date: Mon, 22 Oct 2018 19:58:14 +0200 Subject: [PATCH 016/799] Add overloading to `get` method --- types/cheerio/index.d.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/types/cheerio/index.d.ts b/types/cheerio/index.d.ts index cb8031705e..7f76146257 100644 --- a/types/cheerio/index.d.ts +++ b/types/cheerio/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for Cheerio v0.22.0 // Project: https://github.com/cheeriojs/cheerio -// Definitions by: Bret Little , VILIC VANE , Wayne Maurer , Umar Nizamani , LiJinyao , Chennakrishna +// Definitions by: Bret Little , VILIC VANE , Wayne Maurer , Umar Nizamani , LiJinyao , Chennakrishna , AzSiAz // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface Cheerio { @@ -112,8 +112,10 @@ interface Cheerio { eq(index: number): Cheerio; get(): string[]; + get(): T[]; get(): CheerioElement[]; get(index: number): CheerioElement; + get(index: number): T; index(): number; index(selector: string): number; From a8b6dfd99e9637403c2204d0f2fe8e53f9c8eed3 Mon Sep 17 00:00:00 2001 From: AzSiAz Date: Mon, 22 Oct 2018 20:10:40 +0200 Subject: [PATCH 017/799] Revert "Add overloading to `get` method" This reverts commit 38983e317ac39a234d6bc4106f7f4d0767211800. --- types/cheerio/index.d.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/types/cheerio/index.d.ts b/types/cheerio/index.d.ts index 7f76146257..5f8b89fe60 100644 --- a/types/cheerio/index.d.ts +++ b/types/cheerio/index.d.ts @@ -112,10 +112,8 @@ interface Cheerio { eq(index: number): Cheerio; get(): string[]; - get(): T[]; get(): CheerioElement[]; get(index: number): CheerioElement; - get(index: number): T; index(): number; index(selector: string): number; From 023af83ed4d02ef61234532448ac49d8c27dad5b Mon Sep 17 00:00:00 2001 From: AzSiAz Date: Mon, 22 Oct 2018 20:11:22 +0200 Subject: [PATCH 018/799] Add correct overloading to `get` method --- types/cheerio/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/cheerio/index.d.ts b/types/cheerio/index.d.ts index 5f8b89fe60..b04e0f009d 100644 --- a/types/cheerio/index.d.ts +++ b/types/cheerio/index.d.ts @@ -111,6 +111,7 @@ interface Cheerio { eq(index: number): Cheerio; + get(): any[] get(): string[]; get(): CheerioElement[]; get(index: number): CheerioElement; From ea89485ed31827b073360568d9eca34e6401822a Mon Sep 17 00:00:00 2001 From: Clayton Astrom Date: Wed, 24 Oct 2018 09:44:07 -0500 Subject: [PATCH 019/799] 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 020/799] 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 021/799] 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 022/799] 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 023/799] 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 024/799] 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 025/799] 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 026/799] 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 b178a98ffd261b1bcc0c7c220ab8bc46b3f44cf8 Mon Sep 17 00:00:00 2001 From: Dave Cardwell Date: Wed, 24 Oct 2018 20:53:02 -0400 Subject: [PATCH 027/799] [browserslist] Add initial types for browserslist --- types/browserslist/browserslist-tests.ts | 22 ++++++++++++++++ types/browserslist/index.d.ts | 33 ++++++++++++++++++++++++ types/browserslist/tsconfig.json | 16 ++++++++++++ types/browserslist/tslint.json | 1 + 4 files changed, 72 insertions(+) create mode 100644 types/browserslist/browserslist-tests.ts create mode 100644 types/browserslist/index.d.ts create mode 100644 types/browserslist/tsconfig.json create mode 100644 types/browserslist/tslint.json diff --git a/types/browserslist/browserslist-tests.ts b/types/browserslist/browserslist-tests.ts new file mode 100644 index 0000000000..d5e88e5b5d --- /dev/null +++ b/types/browserslist/browserslist-tests.ts @@ -0,0 +1,22 @@ +import browserslist from "browserslist"; + +browserslist(); // $ExpectType string[] +browserslist(""); // $ExpectType string[] +browserslist([""]); // $ExpectType string[] + +const opts: browserslist.Options[] = [ + {}, + { path: "" }, + { env: "" }, + { stats: { "": { "": 0 } } }, + { config: "" }, + { ignoreUnknownVersions: false }, + { dangerousExtend: false } +]; +for (const opt of opts) { + browserslist("", opt); // $ExpectType string[] + browserslist([""], opt); // $ExpectType string[] +} + +browserslist.coverage([""]); // $ExpectType number +browserslist.coverage([""], { "": { "": 0 } }); // $ExpectType number diff --git a/types/browserslist/index.d.ts b/types/browserslist/index.d.ts new file mode 100644 index 0000000000..6edcb47ab4 --- /dev/null +++ b/types/browserslist/index.d.ts @@ -0,0 +1,33 @@ +// Type definitions for browserslist 4.3 +// Project: https://github.com/browserslist/browserslist#readme +// Definitions by: Dave Cardwell +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace browserslist { + interface Browserslist { + (queries?: string | ReadonlyArray, opts?: Options): string[]; + + coverage: (browsers: ReadonlyArray, stats?: Stats) => number; + + clearCaches: () => void; + } + + interface Stats { + [browser: string]: { + [version: string]: number; + }; + } + + interface Options { + path?: string; + env?: string; + stats?: Stats; + config?: string; + ignoreUnknownVersions?: boolean; + dangerousExtend?: boolean; + } +} + +declare var browserslist: browserslist.Browserslist; + +export default browserslist; diff --git a/types/browserslist/tsconfig.json b/types/browserslist/tsconfig.json new file mode 100644 index 0000000000..11138a612f --- /dev/null +++ b/types/browserslist/tsconfig.json @@ -0,0 +1,16 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": ["index.d.ts", "browserslist-tests.ts"] +} diff --git a/types/browserslist/tslint.json b/types/browserslist/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/browserslist/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 46257f5c7bde050da55efd1039c1ed428ec303b0 Mon Sep 17 00:00:00 2001 From: Willy Zhang Date: Fri, 26 Oct 2018 20:33:32 -0700 Subject: [PATCH 028/799] Update CircuitBreaker with more functionality --- types/opossum/index.d.ts | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/types/opossum/index.d.ts b/types/opossum/index.d.ts index f1e14a939b..6ad4311af8 100644 --- a/types/opossum/index.d.ts +++ b/types/opossum/index.d.ts @@ -1,22 +1,25 @@ // Type definitions for opossum 1.8 // Project: https://github.com/bucharest-gold/opossum // Definitions by: Quinn Langille +// Willy Zhang // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 /// import * as stream from "stream"; +import { EventEmitter } from "events"; -export type Action = () => any; +export type Action = (...args: any[]) => any; -export class CircuitBreaker { +export class CircuitBreaker extends EventEmitter { clearCache(): void; close(): void; disable(): void; enable(): void; - fallback(): CircuitBreaker; - fire(): Promise; - healthCheck(func: () => Promise, interval: number): Promise; + fallback(func?: (...args: any[]) => any): this; + fire(...args: any[]): Promise; + healthCheck(func: (...args: any[]) => Promise, interval?: number): Promise; + on(event: string | symbol, listener: (...args: any[]) => void): this; open(): void; promisify(action: Action): Promise; stats(): stream.Transform; @@ -33,6 +36,22 @@ export class CircuitBreaker { static readonly warmUp: symbol; } +export enum Event { + cacheHit = 'cacheHit', + cacheMiss = 'cacheMiss', + close = 'close', + failure = 'failure', + fallback = 'fallback', + fire = 'fire', + halfOpen = 'halfOpen', + healthCheckFailed = 'health-check-failed', + open = 'open', + reject = 'reject', + semaphoreLocked = 'semaphore-locked', + success = 'success', + timeout = 'timeout' +} + export interface CircuitBreakerOptions { timeout?: number; maxFailures?: number; From 732040440df7b3b35244b09e24c893a9151dfd0e Mon Sep 17 00:00:00 2001 From: Alec Hill Date: Mon, 29 Oct 2018 12:25:51 +0000 Subject: [PATCH 029/799] 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 030/799] 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 031/799] 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 032/799] 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 033/799] 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 1d5090a739f57727e54b11976d2a43db9523692d Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 16:16:07 -0400 Subject: [PATCH 034/799] [prompts] infer answers types ``` const answers = await prompts({ name: "hello" }) answers.asdf // error answers.name // good ``` --- types/prompts/index.d.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index 152d6326e8..498a6b0c33 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -6,7 +6,7 @@ export = prompts; -declare function prompts(questions: prompts.PromptObject | prompts.PromptObject[], options?: prompts.Options): any; +declare function prompts(questions: prompts.PromptObject | prompts.PromptObject[], options?: prompts.Options): prompts.Answers; declare namespace prompts { // Circular reference from prompts @@ -51,9 +51,9 @@ declare namespace prompts { onCancel: (prompt: PromptObject, answers: any) => void; } - interface PromptObject { + interface PromptObject { type: string | ((prev: any, values: any, prompt: PromptObject) => void); - name: string | ((prev: any, values: any, prompt: PromptObject) => void); + name: T | ((prev: any, values: any, prompt: PromptObject) => void); message?: string | ((prev: any, values: any, prompt: PromptObject) => void); initial?: string; style?: string; @@ -73,4 +73,6 @@ declare namespace prompts { suggest?: ((prev: any, values: any, prompt: PromptObject) => void); limit?: number; } + + type Answers = { [id in T]: string }; } From 1596d8fa41b3f4ead68a9dfc9d299ace430bd375 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 16:22:38 -0400 Subject: [PATCH 035/799] [prompts] upgrade ts version --- types/prompts/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index 498a6b0c33..cbec1d3ed7 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -2,7 +2,7 @@ // Project: https://github.com/terkelg/prompts // Definitions by: Berkay GURSOY // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.3 export = prompts; From 3f661f9239153ec881f8545266b241f0ace9f6f1 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 16:36:20 -0400 Subject: [PATCH 036/799] Update index.d.ts --- types/prompts/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index cbec1d3ed7..1bc9c0ca66 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -6,7 +6,7 @@ export = prompts; -declare function prompts(questions: prompts.PromptObject | prompts.PromptObject[], options?: prompts.Options): prompts.Answers; +declare function prompts(questions: prompts.PromptObject | Array>, options?: prompts.Options): prompts.Answers; declare namespace prompts { // Circular reference from prompts @@ -73,6 +73,6 @@ declare namespace prompts { suggest?: ((prev: any, values: any, prompt: PromptObject) => void); limit?: number; } - + type Answers = { [id in T]: string }; } From b8190e564863776b1804e2ad8c11ed3ba742af74 Mon Sep 17 00:00:00 2001 From: spacejack Date: Fri, 2 Nov 2018 17:20:31 -0400 Subject: [PATCH 037/799] Fix signatures for drawPolygon, drawPolyline, drawBezier --- types/gm/gm-tests.ts | 14 +++++++------- types/gm/index.d.ts | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/types/gm/gm-tests.ts b/types/gm/gm-tests.ts index 9ff16940b7..b22b7ffbc5 100644 --- a/types/gm/gm-tests.ts +++ b/types/gm/gm-tests.ts @@ -325,17 +325,17 @@ gm(src) }) .draw(options) .drawArc(x, y, x, y, radius, radius) - .drawBezier(x, y, x, y) - .drawBezier(x, y, x, y, x, y) - .drawBezier(x, y, x, y, x, y, x, y) + .drawBezier([x, y], [x, y]) + .drawBezier([x, y], [x, y], [x, y]) + .drawBezier([x, y], [x, y], [x, y], [x, y]) .drawCircle(x, y, x, y) .drawEllipse(x, y, radius, radius, radius, radius) .drawLine(x, y, x, y) .drawPoint(x, y) - .drawPolygon(x, y, x, y, x, y) - .drawPolygon(x, y, x, y, x, y, x, y) - .drawPolyline(x, y, x, y, x, y) - .drawPolyline(x, y, x, y, x, y, x, y) + .drawPolygon([x, y], [x, y], [x, y]) + .drawPolygon([x, y], [x, y], [x, y], [x, y]) + .drawPolyline([x, y], [x, y], [x, y]) + .drawPolyline([x, y], [x, y], [x, y], [x, y]) .drawRectangle(x, y, x, y) .drawRectangle(x, y, x, y, radius) .drawRectangle(x, y, x, y, radius, radius) diff --git a/types/gm/index.d.ts b/types/gm/index.d.ts index 6a5214d8a1..887719e999 100644 --- a/types/gm/index.d.ts +++ b/types/gm/index.d.ts @@ -295,13 +295,13 @@ declare namespace m { // Drawing Operations draw(args: string): State; drawArc(x0: number, y0: number, x1: number, y1: number, r0: number, r1: number): State; - drawBezier(x0: number, y0: number, x1: number, y1: number, x2?: number, y2?: number, ...coords: number[]): State; + drawBezier(...coords: number[][]): State; drawCircle(x0: number, y0: number, x1: number, y1: number): State; drawEllipse(x0: number, y0: number, rx: number, ry: number, a0: number, a1: number): State; drawLine(x0: number, y0: number, x1: number, y1: number): State; drawPoint(x: number, y: number): State; - drawPolygon(x0: number, y0: number, x1: number, y1: number, x2: number, y2: number, ...coords: number[]): State; - drawPolyline(x0: number, y0: number, x1: number, y1: number, x2: number, y2: number, ...coords: number[]): State; + drawPolygon(...coords: number[][]): State; + drawPolyline(...coords: number[][]): State; drawRectangle(x0: number, y0: number, x1: number, y1: number, wc?: number, hc?: number): State; drawText(x: number, y: number, text: string, gravity?: GravityDirection | string): State; fill(color: string): State; From 1bccd1bcc12e89d736905721871663487837e3f0 Mon Sep 17 00:00:00 2001 From: spacejack Date: Fri, 2 Nov 2018 17:40:28 -0400 Subject: [PATCH 038/799] Require minimum number of coordinates --- types/gm/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/gm/index.d.ts b/types/gm/index.d.ts index 887719e999..438a7733b6 100644 --- a/types/gm/index.d.ts +++ b/types/gm/index.d.ts @@ -295,13 +295,13 @@ declare namespace m { // Drawing Operations draw(args: string): State; drawArc(x0: number, y0: number, x1: number, y1: number, r0: number, r1: number): State; - drawBezier(...coords: number[][]): State; + drawBezier(coord0: number[], coord1: number[], ...coords: number[][]): State; drawCircle(x0: number, y0: number, x1: number, y1: number): State; drawEllipse(x0: number, y0: number, rx: number, ry: number, a0: number, a1: number): State; drawLine(x0: number, y0: number, x1: number, y1: number): State; drawPoint(x: number, y: number): State; - drawPolygon(...coords: number[][]): State; - drawPolyline(...coords: number[][]): State; + drawPolygon(coord0: number[], coord1: number[], coord2: number[], ...coords: number[][]): State; + drawPolyline(coord0: number[], coord1: number[], coord2: number[], ...coords: number[][]): State; drawRectangle(x0: number, y0: number, x1: number, y1: number, wc?: number, hc?: number): State; drawText(x: number, y: number, text: string, gravity?: GravityDirection | string): State; fill(color: string): State; From d8b9276ec0b8fd5a4fb74dae2aa4951f4483f170 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 17:45:48 -0400 Subject: [PATCH 039/799] Update index.d.ts --- types/prompts/index.d.ts | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index 1bc9c0ca66..b5b9f38285 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -6,7 +6,10 @@ export = prompts; -declare function prompts(questions: prompts.PromptObject | Array>, options?: prompts.Options): prompts.Answers; +declare function prompts( + questions: prompts.PromptObject | Array>, + options?: prompts.Options +): Promise>; declare namespace prompts { // Circular reference from prompts @@ -15,8 +18,7 @@ declare namespace prompts { function inject(obj: any): void; namespace inject { - const prototype: { - }; + const prototype: {}; } namespace prompts { @@ -52,14 +54,14 @@ declare namespace prompts { } interface PromptObject { - type: string | ((prev: any, values: any, prompt: PromptObject) => void); - name: T | ((prev: any, values: any, prompt: PromptObject) => void); - message?: string | ((prev: any, values: any, prompt: PromptObject) => void); + type: ValueOrFunc; + name: ValueOrFunc; + message?: ValueOrFunc; initial?: string; style?: string; - format?: ((prev: any, values: any, prompt: PromptObject) => void); - validate?: ((prev: any, values: any, prompt: PromptObject) => void); - onState?: ((prev: any, values: any, prompt: PromptObject) => void); + format?: PrevCaller; + validate?: PrevCaller; + onState?: PrevCaller; min?: number; max?: number; float?: boolean; @@ -74,5 +76,13 @@ declare namespace prompts { limit?: number; } - type Answers = { [id in T]: string }; + type Answers = { [id in T]: any }; + + type PrevCaller = ( + prev: any, + values: Answers, + prompt: PromptObject + ) => R; + + type ValueOrFunc = T | PrevCaller; } From be502a6c4bbd853dd10f7eb14bf371e40110c12e Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 18:04:02 -0400 Subject: [PATCH 040/799] Update prompts-tests.ts --- types/prompts/prompts-tests.ts | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/types/prompts/prompts-tests.ts b/types/prompts/prompts-tests.ts index 0b89cb3721..bd35868c66 100644 --- a/types/prompts/prompts-tests.ts +++ b/types/prompts/prompts-tests.ts @@ -1,8 +1,14 @@ import prompts = require("prompts"); -const response = prompts({ - type: 'number', - name: 'value', - message: 'Input value to double:', - validate: (value: any) => value < 0 ? `Cant be less than zero` : true -}); +type HasProperty = K extends keyof T ? true : false; + +(async () => { + const response = await prompts({ + type: "number", + name: "value", + message: "Input value to double:", + validate: (value: any) => (value < 0 ? `Cant be less than zero` : true) + }); + const HasPropValue: HasProperty = true; + const DoesntHavePropAsdf: HasProperty = false; +})(); From 76cb0a95c9ec11e43ba79a074d808be8e7944726 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 18:07:39 -0400 Subject: [PATCH 041/799] Update index.d.ts --- types/prompts/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index b5b9f38285..9155ded98b 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -1,6 +1,7 @@ // Type definitions for prompts 1.1 // Project: https://github.com/terkelg/prompts // Definitions by: Berkay GURSOY +// Daniel Perez Alvarez // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 From a341af86b1685e2b45b100da1cd580a6d05193a6 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 18:33:51 -0400 Subject: [PATCH 042/799] Update index.d.ts --- types/prompts/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index 9155ded98b..6982173159 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Berkay GURSOY // Daniel Perez Alvarez // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 +// TypeScript Version: 2.8 export = prompts; From 2ab4320c9c34aff98377268c996dfee2852a58d7 Mon Sep 17 00:00:00 2001 From: Daniel Perez Alvarez Date: Fri, 2 Nov 2018 18:48:39 -0400 Subject: [PATCH 043/799] Update index.d.ts --- types/prompts/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/prompts/index.d.ts b/types/prompts/index.d.ts index 6982173159..7aa3f2ea63 100644 --- a/types/prompts/index.d.ts +++ b/types/prompts/index.d.ts @@ -77,13 +77,13 @@ declare namespace prompts { limit?: number; } - type Answers = { [id in T]: any }; + type Answers = { [id in T]: any }; - type PrevCaller = ( + type PrevCaller = ( prev: any, values: Answers, prompt: PromptObject ) => R; - type ValueOrFunc = T | PrevCaller; + type ValueOrFunc = T | PrevCaller; } From ed4de5dd4c9be7f22f360b7e3e801098c41f2aa8 Mon Sep 17 00:00:00 2001 From: Simon Meusel Date: Sat, 3 Nov 2018 11:44:41 +0100 Subject: [PATCH 044/799] 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 85570ae981931acaf028425d7bb5359e90837845 Mon Sep 17 00:00:00 2001 From: olshansky Date: Sat, 3 Nov 2018 14:17:13 +0200 Subject: [PATCH 045/799] [@types/paypal-rest-sdk] add payer_info type --- types/paypal-rest-sdk/index.d.ts | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/types/paypal-rest-sdk/index.d.ts b/types/paypal-rest-sdk/index.d.ts index d6457fc981..0d2eea80a9 100644 --- a/types/paypal-rest-sdk/index.d.ts +++ b/types/paypal-rest-sdk/index.d.ts @@ -258,6 +258,22 @@ export interface Item { url?: string; } +export interface PayerInfo { + email?: string; + readonly salutation?: string; + readonly first_name?: string; + readonly middle_name?: string; + readonly last_name?: string; + readonly suffix?: string; + readonly payer_id?: string; + birth_date?: string; + tax_id?: string; + tax_id_type?: string; + country_code?: string; + billing_address?: Address; + readonly shipping_address?: Address; +} + export interface RefundRequest { amount?: Amount; description?: string; @@ -266,8 +282,7 @@ export interface RefundRequest { invoice_number?: string; refund_advice?: boolean; items?: Item[]; - // TODO: Type this https://developer.paypal.com/docs/api/payments/#definition-payer_info - payer_info?: any; + payer_info?: PayerInfo; supplementary_data?: any[]; } From f482096dc54638fb2211d673d762f3d051fa271e Mon Sep 17 00:00:00 2001 From: Boris Sergeyev Date: Sat, 3 Nov 2018 19:20:07 +0100 Subject: [PATCH 046/799] [react-redux] implemented proper typings for thunk action creators in TDispatchProps --- types/react-redux/index.d.ts | 38 +++++++++++++++++++++---- types/react-redux/react-redux-tests.tsx | 23 +++++++++++++++ 2 files changed, 55 insertions(+), 6 deletions(-) diff --git a/types/react-redux/index.d.ts b/types/react-redux/index.d.ts index 5cbde2e8db..0676941ce9 100644 --- a/types/react-redux/index.d.ts +++ b/types/react-redux/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-redux 6.0.4 +// Type definitions for react-redux 6.0.5 // Project: https://github.com/reduxjs/react-redux // Definitions by: Qubo , // Kenzie Togami , @@ -11,6 +11,7 @@ // Valentin Descamps // Johann Rakotoharisoa // Anatoli Papirovski +// Boris Sergeyev // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -102,7 +103,7 @@ type ConnectedComponentClass = ComponentClass { - >>>( + >>>( component: C ): ConnectedComponentClass, keyof Shared>> & TNeedsProps> } @@ -113,6 +114,19 @@ export interface InferableComponentEnhancerWithProps = InferableComponentEnhancerWithProps +// redux-thunk middleware returns thunk's return value from dispatch call +type WithThunkActionCreators = + TDispatchProps extends object + ? { + [C in keyof TDispatchProps]: C extends (...args: any[]) => any + ? ReturnType extends (...args: any[]) => any + ? ReturnType> + : C + : never + } + : TDispatchProps + + /** * Connects a React component to a Redux store. * @@ -142,12 +156,18 @@ export interface Connect { ( mapStateToProps: null | undefined, mapDispatchToProps: MapDispatchToPropsParam - ): InferableComponentEnhancerWithProps; + ): InferableComponentEnhancerWithProps< + WithThunkActionCreators, + TOwnProps + >; ( mapStateToProps: MapStateToPropsParam, mapDispatchToProps: MapDispatchToPropsParam - ): InferableComponentEnhancerWithProps; + ): InferableComponentEnhancerWithProps< + TStateProps & WithThunkActionCreators, + TOwnProps + >; ( mapStateToProps: MapStateToPropsParam, @@ -185,14 +205,20 @@ export interface Connect { mapDispatchToProps: MapDispatchToPropsParam, mergeProps: null | undefined, options: Options<{}, TStateProps, TOwnProps> - ): InferableComponentEnhancerWithProps; + ): InferableComponentEnhancerWithProps< + WithThunkActionCreators, + TOwnProps + >; ( mapStateToProps: MapStateToPropsParam, mapDispatchToProps: MapDispatchToPropsParam, mergeProps: null | undefined, options: Options - ): InferableComponentEnhancerWithProps; + ): InferableComponentEnhancerWithProps< + TStateProps & WithThunkActionCreators, + TOwnProps + >; ( mapStateToProps: MapStateToPropsParam, diff --git a/types/react-redux/react-redux-tests.tsx b/types/react-redux/react-redux-tests.tsx index 3b25b25843..a5f8c2b4f7 100644 --- a/types/react-redux/react-redux-tests.tsx +++ b/types/react-redux/react-redux-tests.tsx @@ -99,6 +99,29 @@ namespace MapDispatch { const verifyUndefined = } +namespace MapDispatchWithThunkActionCreators { + interface OwnProps { foo: string } + interface DispatchProps { + onClick(): void, + thunkAction(): Promise + } + + class TestComponent extends Component {} + + const mapDispatchToProps = () => ({ + onClick: () => {}, + thunkAction: () => async () => {} + }) + + const Test = connect( + null, + mapDispatchToProps, + )(TestComponent) + + const verify = +} + + namespace MapStateAndDispatchObject { interface ClickPayload { count: number } const onClick: ActionCreator = () => ({ count: 1 }); From 9cb83f7d867456ce599f0bef0f6db378150474b0 Mon Sep 17 00:00:00 2001 From: Paul Hobbel Date: Sun, 4 Nov 2018 17:51:29 +0100 Subject: [PATCH 047/799] 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 048/799] 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 049/799] 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 050/799] 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 051/799] 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 052/799] 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 053/799] 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 054/799] 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 055/799] 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 ` \n' + + "but do b.ca", + { + ignoreTags: ["script", "style"] + } +); + +/* nl2br */ + +/* tagName */ + +linkifyHtml("github.com", { + tagName: "span" +}); + +linkifyHtml("#swag", { + tagName: { + hashtag: "span" + } +}); + +/* target */ + +linkifyHtml("github.com", { + target: "_parent" +}); + +linkifyHtml("test-email@example.com", { + target: { + url: "_parent", + email: null + } +}); + +/* validate */ + +// Don't linkify links that don't begin in a protocol +// e.g., "http://google.com" will be linkified, but "google.com" will not. +linkifyHtml("www.google.com", { + validate: { + url(value) { + return /^(http|ftp)s?:\/\//.test(value); + } + } +}); diff --git a/types/linkifyjs/tsconfig.json b/types/linkifyjs/tsconfig.json new file mode 100644 index 0000000000..be83a56929 --- /dev/null +++ b/types/linkifyjs/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "linkifyjs-tests.ts" + ] +} diff --git a/types/linkifyjs/tslint.json b/types/linkifyjs/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/linkifyjs/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From f0b7bad3514c863feb8dce8a3c107c774028b331 Mon Sep 17 00:00:00 2001 From: Sean Zhu Date: Wed, 28 Nov 2018 23:38:27 -0800 Subject: [PATCH 651/799] rm 'types/linkifyjs/.prettierrc.yml' --- types/linkifyjs/.prettierrc.yml | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 types/linkifyjs/.prettierrc.yml diff --git a/types/linkifyjs/.prettierrc.yml b/types/linkifyjs/.prettierrc.yml deleted file mode 100644 index f2c03d3a72..0000000000 --- a/types/linkifyjs/.prettierrc.yml +++ /dev/null @@ -1,8 +0,0 @@ -tabWidth: 4 -overrides: - - files: ".prettierrc.yml" - options: - tabWidth: 2 - - files: "tsconfig.json" - options: - printWidth: 1 From 14e3429c27feeff00c417c58f9242d991ada091c Mon Sep 17 00:00:00 2001 From: Sean Zhu Date: Thu, 29 Nov 2018 00:05:02 -0800 Subject: [PATCH 652/799] [linkifyjs] Add .html.d.ts to files --- types/linkifyjs/tsconfig.json | 1 + 1 file changed, 1 insertion(+) diff --git a/types/linkifyjs/tsconfig.json b/types/linkifyjs/tsconfig.json index be83a56929..52b1940fcd 100644 --- a/types/linkifyjs/tsconfig.json +++ b/types/linkifyjs/tsconfig.json @@ -19,6 +19,7 @@ }, "files": [ "index.d.ts", + "html.d.ts", "linkifyjs-tests.ts" ] } From 27544c9615a45820dd7c3e6435845531075ee2d7 Mon Sep 17 00:00:00 2001 From: Sean Zhu Date: Thu, 29 Nov 2018 00:10:26 -0800 Subject: [PATCH 653/799] [linkifyjs] Fix lint errors --- types/linkifyjs/html.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/linkifyjs/html.d.ts b/types/linkifyjs/html.d.ts index e366d52fc0..d21de0e3c3 100644 --- a/types/linkifyjs/html.d.ts +++ b/types/linkifyjs/html.d.ts @@ -1,4 +1,4 @@ import { LinkifyOptions } from "./index"; -export let linkifyHtml: (input: string, options?: LinkifyOptions) => string; +export function linkifyHtml(input: string, options?: LinkifyOptions): string; export default linkifyHtml; From 3c744b74bec078faa9a9227ea23c00ffdc0a132a Mon Sep 17 00:00:00 2001 From: Lucas Motta Date: Thu, 29 Nov 2018 10:32:40 +0000 Subject: [PATCH 654/799] Fix ci problems --- types/ssh2-streams/index.d.ts | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/types/ssh2-streams/index.d.ts b/types/ssh2-streams/index.d.ts index e80e529ced..df1e001e0a 100644 --- a/types/ssh2-streams/index.d.ts +++ b/types/ssh2-streams/index.d.ts @@ -1,7 +1,6 @@ // Type definitions for ssh2-streams v0.1.9 // Project: https://github.com/mscdex/ssh2-streams // Definitions by: Ron Buckton -// Definitions by: Lucas Motta // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -1631,11 +1630,6 @@ export interface TransferOptions { step?: (total_transferred: number, chunk: number, total: number) => void; } -export interface ReadFileOptions { - encoding?: string - flag?: string -} - export interface ReadStreamOptions { flags?: string; encoding?: string; @@ -1704,4 +1698,9 @@ export interface ParsedKey { publicOrig: Buffer; ppk?: boolean; privateMAC?: string; +} + +export interface ReadFileOptions { + encoding?: string; + flag?: string; } \ No newline at end of file From 5c1c6b290b6446c1ba270e083286d1c487da9c2f Mon Sep 17 00:00:00 2001 From: Silas Rech Date: Thu, 29 Nov 2018 13:12:37 +0100 Subject: [PATCH 655/799] [crumb] add typings --- types/crumb/crumb-tests.ts | 47 +++++++++++++++ types/crumb/index.d.ts | 114 +++++++++++++++++++++++++++++++++++++ types/crumb/tsconfig.json | 23 ++++++++ types/crumb/tslint.json | 1 + 4 files changed, 185 insertions(+) create mode 100644 types/crumb/crumb-tests.ts create mode 100644 types/crumb/index.d.ts create mode 100644 types/crumb/tsconfig.json create mode 100644 types/crumb/tslint.json diff --git a/types/crumb/crumb-tests.ts b/types/crumb/crumb-tests.ts new file mode 100644 index 0000000000..90612a3e4a --- /dev/null +++ b/types/crumb/crumb-tests.ts @@ -0,0 +1,47 @@ +import * as hapi from 'hapi'; +import * as crumb from 'crumb'; + +const server = new hapi.Server({ port: 8000 }); + +server.register({ + plugin: crumb, + options: { + key: 'csrf-token', + size: 50, + autoGenerate: true, + addToViewContext: true, + cookieOptions: { + path: '/', + }, + headerName: 'X-CSRF-Token', + restful: true, + skip: () => false, + enforce: true, + logUnauthorized: false, + } +}); + +server.route({ + method: 'get', + path: '/', + handler: async (_, h) => { + return h.continue; + }, +}); + +server.route({ + method: 'get', + path: '/custom', + options: { + plugins: { + crumb: { + key: 'x-csrf-token', + source: 'query', + restful: true, + }, + }, + }, + handler: async (_, h) => { + return h.continue; + }, +}); diff --git a/types/crumb/index.d.ts b/types/crumb/index.d.ts new file mode 100644 index 0000000000..16311c99bf --- /dev/null +++ b/types/crumb/index.d.ts @@ -0,0 +1,114 @@ +// Type definitions for crumb 7.2 +// Project: https://github.com/hapijs/crumb +// Definitions by: Silas Rech +// Simon Schick +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +import { Request, Plugin, ResponseToolkit, ServerStateCookieOptions } from 'hapi'; + +declare module 'hapi' { + interface PluginSpecificConfiguration { + crumb?: boolean | { + /** + * The name of the cookie to store the CSRF crumb into. + */ + key?: string; + + /** + * Specifies how the crumb will be sent in requests. + * + * @default 'payload' + */ + source?: 'payload' | 'query'; + + /** + * Override for the server's 'restful' setting + */ + restful?: boolean; + }; + } +} + +declare namespace crumb { + type SkipFunction = (request?: Request, h?: ResponseToolkit) => boolean; + + interface RegisterOptions { + /** + * The name of the cookie to store the CSRF crumb into. + * + * @default 'crumb' + */ + key?: string; + + /** + * The length of the crumb to generate. + * See {@link https://github.com/hapijs/cryptiles cryptiles} for more information. + * + * @default 43 + */ + size?: number; + + /** + * Whether to automatically generate a new crumb for requests. + * + * @default true + */ + autoGenerate?: boolean; + + /** + * Whether to automatically add the crumb to view contexts as the given key. + * + * @default true + */ + addToViewContext?: boolean; + + /** + * Storage options for the cookie containing the crumb + * + * @default { path: '/' } + */ + cookieOptions?: ServerStateCookieOptions; + + /** + * Specify the name of the custom CSRF header. + * + * @default 'X-CSRF-Token' + */ + headerName?: string; + + /** + * RESTful mode that validates crumb tokens from 'X-CSRF-Token' request header for POST, PUT, PATCH and DELETE server routes. + * Disables payload/query crumb validation. + * + * @default false + */ + restful?: boolean; + + /** + * A function which when provided, is called for every request. + * If the provided function returns true, validation and generation of crumb is skipped. + * + * @default false + */ + skip?: boolean | SkipFunction; + + /** + * Using enforce with false will set the CSRF header cookie but won't execute the validation. + * + * @default true + */ + enforce?: boolean; + + /** + * Whether to add to the request log with tag 'crumb' and data 'validation failed'. + * + * @default false + */ + logUnauthorized?: boolean; + } +} + +declare const crumb: Plugin; + +export = crumb; diff --git a/types/crumb/tsconfig.json b/types/crumb/tsconfig.json new file mode 100644 index 0000000000..5beceb6a88 --- /dev/null +++ b/types/crumb/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "crumb-tests.ts" + ] +} diff --git a/types/crumb/tslint.json b/types/crumb/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/crumb/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 7b89694607cb4a4d602f7600bb582880075b03cd Mon Sep 17 00:00:00 2001 From: Michael Pertl Date: Thu, 29 Nov 2018 16:08:35 +0100 Subject: [PATCH 656/799] [@types/ssh2-sftp-client] "Formatting: Either use all tabs, or always use 4 spaces" --- types/ssh2-sftp-client/index.d.ts | 65 ++++++++++++++++++------------- 1 file changed, 39 insertions(+), 26 deletions(-) diff --git a/types/ssh2-sftp-client/index.d.ts b/types/ssh2-sftp-client/index.d.ts index 2dcaee74e6..165af77ab4 100644 --- a/types/ssh2-sftp-client/index.d.ts +++ b/types/ssh2-sftp-client/index.d.ts @@ -5,35 +5,48 @@ import * as ssh2 from 'ssh2'; import * as ssh2Stream from 'ssh2-streams'; + export = sftp; declare class sftp { - connect(options: ssh2.ConnectConfig): Promise; - list(remoteFilePath: string): Promise; - get(remoteFilePath: string, useCompression?: boolean, encoding?: string | null): Promise; - fastGet(remoteFilePath: string, localPath: string, options?: ssh2Stream.TransferOptions): Promise; - put(input: string | Buffer | NodeJS.ReadableStream, remoteFilePath: string, useCompression?: boolean, encoding?: string): Promise; - fastPut(localPath: string, emoteFilePath: string, options?: ssh2Stream.TransferOptions): Promise; - mkdir(remoteFilePath: string, recursive?: boolean): Promise; - rmdir(remoteFilePath: string, recursive?: boolean): Promise; - delete(remoteFilePath: string): Promise; - rename(remoteSourcePath: string, remoteDestPath: string): Promise; - end(): Promise; - on(event: string, callback: (...args: any[]) => void): void; + connect(options: ssh2.ConnectConfig): Promise; + + list(remoteFilePath: string): Promise; + + get(remoteFilePath: string, useCompression?: boolean, encoding?: string | null): Promise; + + fastGet(remoteFilePath: string, localPath: string, options?: ssh2Stream.TransferOptions): Promise; + + put(input: string | Buffer | NodeJS.ReadableStream, remoteFilePath: string, useCompression?: boolean, encoding?: string): Promise; + + fastPut(localPath: string, emoteFilePath: string, options?: ssh2Stream.TransferOptions): Promise; + + mkdir(remoteFilePath: string, recursive?: boolean): Promise; + + rmdir(remoteFilePath: string, recursive?: boolean): Promise; + + delete(remoteFilePath: string): Promise; + + rename(remoteSourcePath: string, remoteDestPath: string): Promise; + + end(): Promise; + + on(event: string, callback: (...args: any[]) => void): void; } + declare namespace sftp { - interface FileInfo { - type: string; - name: string; - size: number; - modifyTime: number; - accessTime: number; - rights: { - user: string; - group: string; - other: string; - }; - owner: number; - group: number; - } + interface FileInfo { + type: string; + name: string; + size: number; + modifyTime: number; + accessTime: number; + rights: { + user: string; + group: string; + other: string; + }; + owner: number; + group: number; + } } From 8046ef23ae267844626edf0a8f20a91ba0acfad1 Mon Sep 17 00:00:00 2001 From: Michael Pertl Date: Thu, 29 Nov 2018 16:13:29 +0100 Subject: [PATCH 657/799] [@types/ssh2-sftp-client] added type definitions for methods 'exists', 'stat' and 'chmod' --- types/ssh2-sftp-client/index.d.ts | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/types/ssh2-sftp-client/index.d.ts b/types/ssh2-sftp-client/index.d.ts index 165af77ab4..8089810fa9 100644 --- a/types/ssh2-sftp-client/index.d.ts +++ b/types/ssh2-sftp-client/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for ssh2-sftp-client 2.3 +// Type definitions for ssh2-sftp-client 2.4 // Project: https://www.npmjs.com/package/ssh2-sftp-client -// Definitions by: igrayson , Ascari Andrea , Kartik Malik +// Definitions by: igrayson , Ascari Andrea , Kartik Malik , Michael Pertl // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped import * as ssh2 from 'ssh2'; @@ -13,6 +13,10 @@ declare class sftp { list(remoteFilePath: string): Promise; + exists(remotePath: string): Promise; + + stat(remotePath: string): Promise + get(remoteFilePath: string, useCompression?: boolean, encoding?: string | null): Promise; fastGet(remoteFilePath: string, localPath: string, options?: ssh2Stream.TransferOptions): Promise; @@ -29,6 +33,8 @@ declare class sftp { rename(remoteSourcePath: string, remoteDestPath: string): Promise; + chmod(remotePath: string, mode: number | string): Promise; + end(): Promise; on(event: string, callback: (...args: any[]) => void): void; @@ -49,4 +55,14 @@ declare namespace sftp { owner: number; group: number; } + + interface FileStats { + mode: number; + permissions?: any; + owner: number; + group: number; + size: number; + accessTime: number; + modifyTime: number; + } } From c74a7e8088af068f6e1925eb5c953affd3d05a45 Mon Sep 17 00:00:00 2001 From: Michael Pertl Date: Thu, 29 Nov 2018 16:23:22 +0100 Subject: [PATCH 658/799] [@types/ssh2-sftp-client] multi-line "definitions by"; added new tests --- types/ssh2-sftp-client/index.d.ts | 5 ++++- types/ssh2-sftp-client/ssh2-sftp-client-tests.ts | 7 +++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/types/ssh2-sftp-client/index.d.ts b/types/ssh2-sftp-client/index.d.ts index 8089810fa9..ac0c0847ee 100644 --- a/types/ssh2-sftp-client/index.d.ts +++ b/types/ssh2-sftp-client/index.d.ts @@ -1,6 +1,9 @@ // Type definitions for ssh2-sftp-client 2.4 // Project: https://www.npmjs.com/package/ssh2-sftp-client -// Definitions by: igrayson , Ascari Andrea , Kartik Malik , Michael Pertl +// Definitions by: igrayson +// Ascari Andrea +// Kartik Malik +// Michael Pertl // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped import * as ssh2 from 'ssh2'; diff --git a/types/ssh2-sftp-client/ssh2-sftp-client-tests.ts b/types/ssh2-sftp-client/ssh2-sftp-client-tests.ts index 8a9c99fde1..d59e552990 100644 --- a/types/ssh2-sftp-client/ssh2-sftp-client-tests.ts +++ b/types/ssh2-sftp-client/ssh2-sftp-client-tests.ts @@ -1,5 +1,6 @@ import Client = require('ssh2-sftp-client'); import * as fs from 'fs'; + const client = new Client(); client.connect({ @@ -11,6 +12,10 @@ client.connect({ client.list('/remote/path').then(() => null); +client.exists('/remote/path').then(() => null); + +client.stat('/remote/path').then(() => null); + client.get('/remote/path').then(stream => stream.read(0)); client.get('/remote/path', true, 'utf8').then(stream => stream.read(0)); client.get('/remote/path', true, null).then(stream => stream.read(0)); @@ -30,6 +35,8 @@ client.delete('remote/path').then(() => null); client.rename('/remote/from', '/remote/to').then(() => null); +client.chmod('/remote/path', 777).then(() => null); + client.end().then(() => null); client.on('event', () => null); From c042e6eacaf7a1f17d7a46af8a331dc3a417e7a8 Mon Sep 17 00:00:00 2001 From: Michael Pertl Date: Thu, 29 Nov 2018 16:29:27 +0100 Subject: [PATCH 659/799] [@types/ssh2-sftp-client] added missing semicolon --- types/ssh2-sftp-client/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/ssh2-sftp-client/index.d.ts b/types/ssh2-sftp-client/index.d.ts index ac0c0847ee..c568571eb5 100644 --- a/types/ssh2-sftp-client/index.d.ts +++ b/types/ssh2-sftp-client/index.d.ts @@ -18,7 +18,7 @@ declare class sftp { exists(remotePath: string): Promise; - stat(remotePath: string): Promise + stat(remotePath: string): Promise; get(remoteFilePath: string, useCompression?: boolean, encoding?: string | null): Promise; From 0faecf90db4bfe0652254f12fabc07cca8ff1916 Mon Sep 17 00:00:00 2001 From: Mateusz Glapinski Date: Thu, 29 Nov 2018 17:21:08 +0100 Subject: [PATCH 660/799] * overloads few methods that should return Promise if a callback parameter is omitted * adds HostedFieldsHostedFieldsFieldName type * update tests --- types/braintree-web/index.d.ts | 36 +++++++++++++++++++------------- types/braintree-web/test/node.ts | 6 +++--- types/braintree-web/test/web.ts | 13 +++++++----- 3 files changed, 32 insertions(+), 23 deletions(-) diff --git a/types/braintree-web/index.d.ts b/types/braintree-web/index.d.ts index bc5ca0b01f..a2cfdb06c1 100644 --- a/types/braintree-web/index.d.ts +++ b/types/braintree-web/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/braintree/braintree-web // Definitions by: Guy Shahine // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 /** * @module braintree-web/american-express @@ -359,7 +360,8 @@ declare namespace braintree { * }); * @static */ - create: (options: { authorization: string }, callback: callback) => void; + create(options: { authorization: string }): Promise; + create(options: { authorization: string }, callback: callback): void; /** * @description The current version of the SDK, i.e. `3.0.2`. @@ -439,7 +441,8 @@ declare namespace braintree { * @param {callback} callback The second argument, `data`, is the {@link DataCollector} instance. * @returns {void} */ - create: (options: { client: Client, kount: boolean, paypal: boolean }, callback: callback) => void; + create(options: { client: Client, kount: boolean, paypal: boolean }): Promise; + create(options: { client: Client, kount: boolean, paypal: boolean }, callback: callback): void; /** * @description The current version of the SDK, i.e. `3.0.2`. @@ -591,18 +594,15 @@ declare namespace braintree { * @property {?HostedFields~hostedFieldsFieldData} fields.expirationYear {@link HostedFields~hostedFieldsFieldData|hostedFieldsFieldData} for the expiration year field, if it is present. * @property {?HostedFields~hostedFieldsFieldData} fields.postalCode {@link HostedFields~hostedFieldsFieldData|hostedFieldsFieldData} for the postal code field, if it is present. */ - interface HostedFieldsFieldDataFields { - number: HostedFieldsHostedFieldsFieldData; - cvv: HostedFieldsHostedFieldsFieldData; - expirationDate: HostedFieldsHostedFieldsFieldData; - expirationMonth: HostedFieldsHostedFieldsFieldData; - expirationYear: HostedFieldsHostedFieldsFieldData; - postalCode: HostedFieldsHostedFieldsFieldData; - } + type HostedFieldsHostedFieldsFieldName = 'number' | 'cvv' | 'expirationDate' | 'expirationMonth' | 'expirationYear' | 'postalCode'; + + type HostedFieldsFieldDataFields = { + [key in HostedFieldsHostedFieldsFieldName]: HostedFieldsHostedFieldsFieldData; + }; interface HostedFieldsStateObject { cards: HostedFieldsHostedFieldsCard[]; - emittedBy: string; + emittedBy: HostedFieldsHostedFieldsFieldName; fields: HostedFieldsFieldDataFields; } @@ -666,7 +666,8 @@ declare namespace braintree { * } * }, callback); */ - create: (options: { client: Client, fields: HostedFieldFieldOptions, styles: any }, callback: callback) => void; + create(options: { client: Client, fields: HostedFieldFieldOptions, styles: any }): Promise; + create(options: { client: Client, fields: HostedFieldFieldOptions, styles: any }, callback: callback): void; /** @@ -726,7 +727,7 @@ declare namespace braintree { * }); * @returns {void} */ - on(event: string, handler: ((event: any) => any)): void; + on(event: string, handler: ((event: HostedFieldsStateObject) => void)): void; /** * Cleanly tear down anything set up by {@link module:braintree-web/hosted-fields.create|create} @@ -785,7 +786,9 @@ declare namespace braintree { * }); * @returns {void} */ - tokenize(options?: { vault: boolean }, callback?: callback): void; + tokenize(options?: { vault?: boolean, cardholderName?: string, billingAddress?: any }): Promise; + tokenize(options: { vault?: boolean, cardholderName?: string, billingAddress?: any }, callback: callback): void; + tokenize(callback: callback): void; /** * Add a class to a {@link module:braintree-web/hosted-fields~field field}. Useful for updating field styles when events occur elsewhere in your checkout. @@ -1138,7 +1141,8 @@ declare namespace braintree { * client: client * }, callback); */ - create: (options: { client: Client }, callback: callback) => void; + create(options: { client: Client }): Promise; + create(options: { client: Client }, callback: callback): void; /** * @description The current version of the SDK, i.e. `3.0.2`. @@ -1207,6 +1211,7 @@ declare namespace braintree { * } * }); */ + verifyCard(options: { nonce: string, amount: number, addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void, removeFrame?: () => void }): Promise; verifyCard(options: { nonce: string, amount: number, addFrame: (err?: BraintreeError, iframe?: HTMLIFrameElement) => void, removeFrame: () => void }, callback: callback): void; /** @@ -1751,3 +1756,4 @@ declare namespace braintree { export = braintree; export as namespace braintree; + diff --git a/types/braintree-web/test/node.ts b/types/braintree-web/test/node.ts index 9eed5b228d..59db2fb944 100644 --- a/types/braintree-web/test/node.ts +++ b/types/braintree-web/test/node.ts @@ -6,7 +6,7 @@ let clientToken: string = "eyJ2ZXJzaW9uIjoyLCJhdXRob3JpemF0aW9uRmluZ2VycHJpbnQiO braintree.client.create({ authorization: clientToken -}, function (error: braintree.BraintreeError, clientInstance: any) { +}, function (error: braintree.BraintreeError, clientInstance: braintree.Client) { var form: HTMLFormElement = document.getElementById('my-form-id') as HTMLFormElement; var data: { creditCard: braintree.CreditCardInfo } = { @@ -396,7 +396,7 @@ let submitNonceToServer: (nonce: string) => void; braintree.threeDSecure.verifyCard({ nonce: existingNonce, - amount: 123.45, + amount: 123.45, // $ExpectType number addFrame: function (err, iframe) { // Set up your UI and add the iframe. let my3DSContainer = document.createElement('div'); @@ -437,4 +437,4 @@ braintree.threeDSecure.cancelVerifyCard(function (err: braintree.BraintreeError, verifyPayload.nonce; // The nonce returned from the 3ds lookup call verifyPayload.liabilityShifted; // boolean verifyPayload.liabilityShiftPossible; // boolean -}); +}); \ No newline at end of file diff --git a/types/braintree-web/test/web.ts b/types/braintree-web/test/web.ts index 22073363d4..1801cbb497 100644 --- a/types/braintree-web/test/web.ts +++ b/types/braintree-web/test/web.ts @@ -1,10 +1,13 @@ +import { ApplePay } from ".."; +import * as braintree from ".."; + let version: string = braintree.VERSION; let clientToken: string = "eyJ2ZXJzaW9uIjoyLCJhdXRob3JpemF0aW9uRmluZ2VycHJpbnQiOiI0YjlhYzVmYmI4ZTNkYzQzMmFkZjJhNzBlNjZlMWNjY2M5ODRkYzE4ZTM4YmY4NjYzZTM5NjM3NWZjYmQzY2U5fGNyZWF0ZWRfYXQ9MjAxNi0wOS0wOFQwNTowMzo0MC4xNjk1NTUwMzUrMDAwMFx1MDAyNm1lcmNoYW50X2lkPTM0OHBrOWNnZjNiZ3l3MmJcdTAwMjZwdWJsaWNfa2V5PTJuMjQ3ZHY4OWJxOXZtcHIiLCJjb25maWdVcmwiOiJodHRwczovL2FwaS5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tOjQ0My9tZXJjaGFudHMvMzQ4cGs5Y2dmM2JneXcyYi9jbGllbnRfYXBpL3YxL2NvbmZpZ3VyYXRpb24iLCJjaGFsbGVuZ2VzIjpbXSwiZW52aXJvbm1lbnQiOiJzYW5kYm94IiwiY2xpZW50QXBpVXJsIjoiaHR0cHM6Ly9hcGkuc2FuZGJveC5icmFpbnRyZWVnYXRld2F5LmNvbTo0NDMvbWVyY2hhbnRzLzM0OHBrOWNnZjNiZ3l3MmIvY2xpZW50X2FwaSIsImFzc2V0c1VybCI6Imh0dHBzOi8vYXNzZXRzLmJyYWludHJlZWdhdGV3YXkuY29tIiwiYXV0aFVybCI6Imh0dHBzOi8vYXV0aC52ZW5tby5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tIiwiYW5hbHl0aWNzIjp7InVybCI6Imh0dHBzOi8vY2xpZW50LWFuYWx5dGljcy5zYW5kYm94LmJyYWludHJlZWdhdGV3YXkuY29tLzM0OHBrOWNnZjNiZ3l3MmIifSwidGhyZWVEU2VjdXJlRW5hYmxlZCI6dHJ1ZSwicGF5cGFsRW5hYmxlZCI6dHJ1ZSwicGF5cGFsIjp7ImRpc3BsYXlOYW1lIjoiQWNtZSBXaWRnZXRzLCBMdGQuIChTYW5kYm94KSIsImNsaWVudElkIjpudWxsLCJwcml2YWN5VXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3BwIiwidXNlckFncmVlbWVudFVybCI6Imh0dHA6Ly9leGFtcGxlLmNvbS90b3MiLCJiYXNlVXJsIjoiaHR0cHM6Ly9hc3NldHMuYnJhaW50cmVlZ2F0ZXdheS5jb20iLCJhc3NldHNVcmwiOiJodHRwczovL2NoZWNrb3V0LnBheXBhbC5jb20iLCJkaXJlY3RCYXNlVXJsIjpudWxsLCJhbGxvd0h0dHAiOnRydWUsImVudmlyb25tZW50Tm9OZXR3b3JrIjp0cnVlLCJlbnZpcm9ubWVudCI6Im9mZmxpbmUiLCJ1bnZldHRlZE1lcmNoYW50IjpmYWxzZSwiYnJhaW50cmVlQ2xpZW50SWQiOiJtYXN0ZXJjbGllbnQzIiwiYmlsbGluZ0FncmVlbWVudHNFbmFibGVkIjp0cnVlLCJtZXJjaGFudEFjY291bnRJZCI6ImFjbWV3aWRnZXRzbHRkc2FuZGJveCIsImN1cnJlbmN5SXNvQ29kZSI6IlVTRCJ9LCJjb2luYmFzZUVuYWJsZWQiOmZhbHNlLCJtZXJjaGFudElkIjoiMzQ4cGs5Y2dmM2JneXcyYiIsInZlbm1vIjoib2ZmIn0="; braintree.client.create({ authorization: clientToken -}, function (error: braintree.BraintreeError, clientInstance: any) { +}, function (error: braintree.BraintreeError, clientInstance: braintree.Client) { var form: HTMLFormElement = document.getElementById('my-form-id') as HTMLFormElement; var data: { creditCard: braintree.CreditCardInfo } = { @@ -62,7 +65,7 @@ braintree.client.create({ select: true } } - }, function (hostedFieldsErr?: braintree.BraintreeError, hostedFieldsInstance?: any) { + }, function (hostedFieldsErr?: braintree.BraintreeError, hostedFieldsInstance?: braintree.HostedFields) { if (hostedFieldsErr) { // Handle error in Hosted Fields creation @@ -178,7 +181,7 @@ braintree.client.create({ }); }); - braintree.applePay.create({ client: clientInstance }, function (createErr?: braintree.BraintreeError, applePayInstance?: any) { + braintree.applePay.create({ client: clientInstance }, function (createErr?: braintree.BraintreeError, applePayInstance?: ApplePay) { if (createErr) { // Handle error in client creation console.log(`Error Code: ${error.code}, Type: ${error.type}, Message: ${error.message}, Details: ${error.details}`); @@ -194,7 +197,7 @@ braintree.client.create({ total: { label: 'Your Label', amount: '10.00' }, }; - var paymentRequest = braintree.applePay.createPaymentRequest(request); + var paymentRequest = applePayInstance.createPaymentRequest(request); console.log(paymentRequest); // { total: { }, countryCode: 'US', currencyCode: 'USD', merchantCapabilities: [ ], supportedNetworks: [ ] } @@ -394,7 +397,7 @@ let submitNonceToServer: (nonce: string) => void; braintree.threeDSecure.verifyCard({ nonce: existingNonce, - amount: 123.45, + amount: 123.45, // $ExpectType number addFrame: function (err, iframe) { // Set up your UI and add the iframe. let my3DSContainer = document.createElement('div'); From e02b8523a1f3ea4f6788de1dee5727e43ad9a053 Mon Sep 17 00:00:00 2001 From: Lukas Elmer Date: Thu, 29 Nov 2018 17:29:43 +0100 Subject: [PATCH 661/799] improve superagent.agent() typing --- types/superagent/index.d.ts | 2 +- types/superagent/superagent-tests.ts | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/types/superagent/index.d.ts b/types/superagent/index.d.ts index 971cc3c4c2..261ea99bed 100644 --- a/types/superagent/index.d.ts +++ b/types/superagent/index.d.ts @@ -45,7 +45,7 @@ declare namespace request { // tslint:disable-next-line:unified-signatures (method: string, url: string): SuperAgentRequest; - agent(): SuperAgent; + agent(): this & Request & SuperAgent; serialize: { [type: string]: Serializer }; parse: { [type: string]: Parser }; } diff --git a/types/superagent/superagent-tests.ts b/types/superagent/superagent-tests.ts index c063c819be..2e13d5b90a 100644 --- a/types/superagent/superagent-tests.ts +++ b/types/superagent/superagent-tests.ts @@ -421,3 +421,15 @@ request .get('/echo') .use(echoPlugin) .end(); + +async function testDefaultOptions() { + // Default options for multiple requests + const agentWithDefaultOptions = request.agent() + .use(() => null) + .auth('digest', 'secret', {type:'auto'}); + + await agentWithDefaultOptions.get('/with-plugin-and-auth'); + await agentWithDefaultOptions.get('/also-with-plugin-and-auth'); +} + +testDefaultOptions(); From bf07afd86497cc8195477b8be5e904f830514159 Mon Sep 17 00:00:00 2001 From: Lukas Elmer Date: Thu, 29 Nov 2018 17:34:25 +0100 Subject: [PATCH 662/799] improve formatting and whitespaces --- types/superagent/superagent-tests.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/types/superagent/superagent-tests.ts b/types/superagent/superagent-tests.ts index 2e13d5b90a..44ef7cf773 100644 --- a/types/superagent/superagent-tests.ts +++ b/types/superagent/superagent-tests.ts @@ -424,9 +424,10 @@ request async function testDefaultOptions() { // Default options for multiple requests - const agentWithDefaultOptions = request.agent() + const agentWithDefaultOptions = request + .agent() .use(() => null) - .auth('digest', 'secret', {type:'auto'}); + .auth('digest', 'secret', { type: 'auto' }); await agentWithDefaultOptions.get('/with-plugin-and-auth'); await agentWithDefaultOptions.get('/also-with-plugin-and-auth'); From 09cf6f908a2bd4d341d80a89aa735d52fd5ad8a9 Mon Sep 17 00:00:00 2001 From: Lukas Elmer Date: Thu, 29 Nov 2018 17:36:21 +0100 Subject: [PATCH 663/799] update header --- types/superagent/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/superagent/index.d.ts b/types/superagent/index.d.ts index 261ea99bed..c10ff467bb 100644 --- a/types/superagent/index.d.ts +++ b/types/superagent/index.d.ts @@ -6,6 +6,7 @@ // Shrey Jain // Alec Zopf // Adam Haglund +// Lukas Elmer // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 From 84d0e5f3c6ed696e578b99865567b4ad93814368 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 11:24:47 -0700 Subject: [PATCH 664/799] update react-flatpickr definitions --- types/react-flatpickr/index.d.ts | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index a0a9725ccd..973f30efc9 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -1,18 +1,26 @@ -// Type definitions for react-flatpickr 3.2 +// Type definitions for react-flatpickr 3.6.4 // Project: https://github.com/coderhaoxin/react-flatpickr // Definitions by: begincalendar +// snaveevans // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 -import { Component } from 'react'; -import flatpickr from 'flatpickr'; +import { Component } from "react"; +import flatpickr from "flatpickr"; export interface DateTimePickerProps { - defaultValue?: string; - options?: flatpickr.Options.Options; - onChange?: flatpickr.Options.Hook; - value?: string; - className?: string; + defaultValue?: string; + options?: flatpickr.Options.Options; + onChange?: flatpickr.Options.Hook; + onOpen?: flatpickr.Options.Hook; + onClose?: flatpickr.Options.Hook; + onMonthChange?: flatpickr.Options.Hook; + onYearChange?: flatpickr.Options.Hook; + onReady?: flatpickr.Options.Hook; + onValueUpdate?: flatpickr.Options.Hook; + onDayCreate?: flatpickr.Options.Hook; + value?: string | Date | number | Array; + children?: JSX.Element; } export default class DatePicker extends Component {} From f8ad24974118da570659fcaf7a6f35271e828f15 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 11:42:10 -0700 Subject: [PATCH 665/799] refactor react-flatpickr test --- .../react-flatpickr/react-flatpickr-tests.tsx | 50 ++++++++++++++----- 1 file changed, 38 insertions(+), 12 deletions(-) diff --git a/types/react-flatpickr/react-flatpickr-tests.tsx b/types/react-flatpickr/react-flatpickr-tests.tsx index 452d8529b4..ce7122a47f 100644 --- a/types/react-flatpickr/react-flatpickr-tests.tsx +++ b/types/react-flatpickr/react-flatpickr-tests.tsx @@ -1,22 +1,48 @@ -import flatpickr from 'flatpickr'; -import * as React from 'react'; -import DatePicker from 'react-flatpickr'; +import flatpickr from "flatpickr"; +import * as React from "react"; +import DatePicker from "react-flatpickr"; -const noParamsElement = ; +const noParamsElement = ; -const defaultValueElement = ; +const defaultValueElement = ; const options = { - dateFormat: 'YYYY-MM-DD' + dateFormat: "YYYY-MM-DD" }; -const optionsElement = ; +const optionsElement = ; -const onChange = ( - selectedDates: Date[], dateStr: string, instance: flatpickr.Instance, +const hook = ( + selectedDates: Date[], + dateStr: string, + instance: flatpickr.Instance, elem: HTMLElement ) => null; -const onChangeElement = ; +const onChangeElement = ; +const onOpenElement = ; +const onCloseElement = ; +const onMonthChangeElement = ; +const onYearChangeElement = ; +const onReadyElement = ; +const onValueUpdateElement = ; +const onDayCreateElement = ; -const valueElement = ; +const valueStringElement = ; +const valueDateElement = ; +const valueNumberElement = ; +const valueStringArrayElement = ( + +); +const valueDateArrayElement = ( + +); +const valueNumberArrayElement = ( + +); -const classNameElement = ; +const wrappedElement = ( + + + +); From 0085b9868c6252a56fed4690444231dbd8cb8099 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 11:45:23 -0700 Subject: [PATCH 666/799] react-flatpickr remove minor version --- types/react-flatpickr/index.d.ts | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index 973f30efc9..9f60b4d7be 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-flatpickr 3.6.4 +// Type definitions for react-flatpickr 3.6 // Project: https://github.com/coderhaoxin/react-flatpickr // Definitions by: begincalendar // snaveevans @@ -9,18 +9,18 @@ import { Component } from "react"; import flatpickr from "flatpickr"; export interface DateTimePickerProps { - defaultValue?: string; - options?: flatpickr.Options.Options; - onChange?: flatpickr.Options.Hook; - onOpen?: flatpickr.Options.Hook; - onClose?: flatpickr.Options.Hook; - onMonthChange?: flatpickr.Options.Hook; - onYearChange?: flatpickr.Options.Hook; - onReady?: flatpickr.Options.Hook; - onValueUpdate?: flatpickr.Options.Hook; - onDayCreate?: flatpickr.Options.Hook; - value?: string | Date | number | Array; - children?: JSX.Element; + defaultValue?: string; + options?: flatpickr.Options.Options; + onChange?: flatpickr.Options.Hook; + onOpen?: flatpickr.Options.Hook; + onClose?: flatpickr.Options.Hook; + onMonthChange?: flatpickr.Options.Hook; + onYearChange?: flatpickr.Options.Hook; + onReady?: flatpickr.Options.Hook; + onValueUpdate?: flatpickr.Options.Hook; + onDayCreate?: flatpickr.Options.Hook; + value?: string | Date | number | Array; + children?: JSX.Element; } export default class DatePicker extends Component {} From c652a0afb4330ca150f1755bba040cf72b4ec5f5 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 11:47:37 -0700 Subject: [PATCH 667/799] Revert "react-flatpickr remove minor version" This reverts commit 0085b9868c6252a56fed4690444231dbd8cb8099. --- types/react-flatpickr/index.d.ts | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index 9f60b4d7be..973f30efc9 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-flatpickr 3.6 +// Type definitions for react-flatpickr 3.6.4 // Project: https://github.com/coderhaoxin/react-flatpickr // Definitions by: begincalendar // snaveevans @@ -9,18 +9,18 @@ import { Component } from "react"; import flatpickr from "flatpickr"; export interface DateTimePickerProps { - defaultValue?: string; - options?: flatpickr.Options.Options; - onChange?: flatpickr.Options.Hook; - onOpen?: flatpickr.Options.Hook; - onClose?: flatpickr.Options.Hook; - onMonthChange?: flatpickr.Options.Hook; - onYearChange?: flatpickr.Options.Hook; - onReady?: flatpickr.Options.Hook; - onValueUpdate?: flatpickr.Options.Hook; - onDayCreate?: flatpickr.Options.Hook; - value?: string | Date | number | Array; - children?: JSX.Element; + defaultValue?: string; + options?: flatpickr.Options.Options; + onChange?: flatpickr.Options.Hook; + onOpen?: flatpickr.Options.Hook; + onClose?: flatpickr.Options.Hook; + onMonthChange?: flatpickr.Options.Hook; + onYearChange?: flatpickr.Options.Hook; + onReady?: flatpickr.Options.Hook; + onValueUpdate?: flatpickr.Options.Hook; + onDayCreate?: flatpickr.Options.Hook; + value?: string | Date | number | Array; + children?: JSX.Element; } export default class DatePicker extends Component {} From 5baad0aabf25ca9416d93f06c479d8c6e790a938 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 11:48:28 -0700 Subject: [PATCH 668/799] react-flatpickr remove patch version --- types/react-flatpickr/index.d.ts | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index 973f30efc9..9f60b4d7be 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-flatpickr 3.6.4 +// Type definitions for react-flatpickr 3.6 // Project: https://github.com/coderhaoxin/react-flatpickr // Definitions by: begincalendar // snaveevans @@ -9,18 +9,18 @@ import { Component } from "react"; import flatpickr from "flatpickr"; export interface DateTimePickerProps { - defaultValue?: string; - options?: flatpickr.Options.Options; - onChange?: flatpickr.Options.Hook; - onOpen?: flatpickr.Options.Hook; - onClose?: flatpickr.Options.Hook; - onMonthChange?: flatpickr.Options.Hook; - onYearChange?: flatpickr.Options.Hook; - onReady?: flatpickr.Options.Hook; - onValueUpdate?: flatpickr.Options.Hook; - onDayCreate?: flatpickr.Options.Hook; - value?: string | Date | number | Array; - children?: JSX.Element; + defaultValue?: string; + options?: flatpickr.Options.Options; + onChange?: flatpickr.Options.Hook; + onOpen?: flatpickr.Options.Hook; + onClose?: flatpickr.Options.Hook; + onMonthChange?: flatpickr.Options.Hook; + onYearChange?: flatpickr.Options.Hook; + onReady?: flatpickr.Options.Hook; + onValueUpdate?: flatpickr.Options.Hook; + onDayCreate?: flatpickr.Options.Hook; + value?: string | Date | number | Array; + children?: JSX.Element; } export default class DatePicker extends Component {} From 47b4772299affae7d56351a46668c9624d3b0aba Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 12:01:10 -0700 Subject: [PATCH 669/799] react-flatpickr use ReadonlyArray --- types/react-flatpickr/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index 9f60b4d7be..f9b817bd00 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -19,7 +19,7 @@ export interface DateTimePickerProps { onReady?: flatpickr.Options.Hook; onValueUpdate?: flatpickr.Options.Hook; onDayCreate?: flatpickr.Options.Hook; - value?: string | Date | number | Array; + value?: string | Date | number | ReadonlyArray; children?: JSX.Element; } From 278797da32ebf66fa7bea64cbae7251b074cfa12 Mon Sep 17 00:00:00 2001 From: Alex Jerabek Date: Thu, 29 Nov 2018 12:08:44 -0800 Subject: [PATCH 670/799] Fix HTML brackets --- types/office-js/index.d.ts | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 6df2026b54..3e7f64375f 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -3282,10 +3282,10 @@ declare namespace Office { * * * - * < - * < - * < - * < + * + * + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
OneNote Y
PowerPoint Y Y Y Y
Word Y Y Y Y
*/ settings: Settings; @@ -4699,8 +4699,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
*/ columnCount: number; @@ -4721,8 +4721,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
*/ hasHeaders: boolean; @@ -4756,8 +4756,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
*/ rowCount: number; @@ -4795,8 +4795,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
* * @param tableData An array of arrays ("matrix") or a TableData object that contains one or more columns of data to add to the table. Required. @@ -4835,8 +4835,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
* * @param rows An array of arrays ("matrix") or a TableData object that contains one or more rows of data to add to the table. Required. @@ -4863,8 +4863,8 @@ declare namespace Office { * * * - * < - * < + * + * *
Office for Windows desktop Office Online (in browser) Office for iPad Office for Mac
Access Y
Excel Y Y Y Y
Word Y Y Y Y
Excel Y Y Y Y
Word Y Y Y Y
* * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback. From 3bc0b5bec959415292efd71bf5c188eb170b550e Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 13:25:36 -0700 Subject: [PATCH 671/799] react-flatpickr allow Element array --- types/react-flatpickr/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react-flatpickr/index.d.ts b/types/react-flatpickr/index.d.ts index f9b817bd00..5e3b12fdf8 100644 --- a/types/react-flatpickr/index.d.ts +++ b/types/react-flatpickr/index.d.ts @@ -20,7 +20,7 @@ export interface DateTimePickerProps { onValueUpdate?: flatpickr.Options.Hook; onDayCreate?: flatpickr.Options.Hook; value?: string | Date | number | ReadonlyArray; - children?: JSX.Element; + children?: JSX.Element | JSX.Element[]; } export default class DatePicker extends Component {} From 0ccda5781a317728dc62b4889daac7f8a1b396b0 Mon Sep 17 00:00:00 2001 From: Tyler Date: Thu, 29 Nov 2018 13:31:29 -0700 Subject: [PATCH 672/799] react-flatpickr test multiple elements --- types/react-flatpickr/react-flatpickr-tests.tsx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/types/react-flatpickr/react-flatpickr-tests.tsx b/types/react-flatpickr/react-flatpickr-tests.tsx index ce7122a47f..c51f527707 100644 --- a/types/react-flatpickr/react-flatpickr-tests.tsx +++ b/types/react-flatpickr/react-flatpickr-tests.tsx @@ -46,3 +46,10 @@ const wrappedElement = ( ); + +const wrappedElements = ( + + + + +); From 56761f59b80614fbfc67fd190cbe11f9461f4919 Mon Sep 17 00:00:00 2001 From: Dobes Vandermeer Date: Thu, 29 Nov 2018 12:40:58 -0800 Subject: [PATCH 673/799] Add hint to CollectionAggregationOptions Although this option is, for some reason, not document. It is supported. It follows the format specified here: https://docs.mongodb.com/manual/reference/command/aggregate/ --- types/mongodb/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/mongodb/index.d.ts b/types/mongodb/index.d.ts index b31a8dd7b9..11d425dc30 100644 --- a/types/mongodb/index.d.ts +++ b/types/mongodb/index.d.ts @@ -1294,6 +1294,7 @@ export interface CollectionAggregationOptions { * Allow driver to bypass schema validation in MongoDB 3.2 or higher. */ bypassDocumentValidation?: boolean; + hint?: string | Object; raw?: boolean; promoteLongs?: boolean; promoteValues?: boolean; From 03ae76d4ec1efd6f1ee51d9f8861ec284b808ed2 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Thu, 29 Nov 2018 18:54:27 -0300 Subject: [PATCH 674/799] chore: update definitions Update definitions to match those defined by the library author --- types/unist/index.d.ts | 39 ++++++++++++++++++++++++++++++-------- types/unist/unist-tests.ts | 2 -- 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/types/unist/index.d.ts b/types/unist/index.d.ts index 7433ddcc13..389b26e04f 100644 --- a/types/unist/index.d.ts +++ b/types/unist/index.d.ts @@ -1,40 +1,63 @@ // Type definitions for Unist 2.0 -// Project: https://github.com/syntax-tree/unist +// Project: https://github.com/syntax-tree/unist-ts // Definitions by: bizen241 // Jun Lu +// Hernan Rajchert +// Titus Wormer // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.4 +// TypeScript Version: 3.1 +export as namespace Unist + +// Syntactic units in unist syntax trees are called nodes. export interface Node { + // The variant of a node. type: string; + + // Information from the ecosystem. data?: Data; + + // Location of a node in a source document. + // Must not be present if a node is generated. position?: Position; } export interface Data { - [key: string]: any; + [key: string]: unknown; } +// Location of a node in a source file. export interface Position { + // Place of the first character of the parsed source region. start: Point; + + // Place of the first character after the parsed source region. end: Point; - /** >= 1 */ - indent?: number[]; + + // Start column at each index (plus start line) in the source region, + // for elements that span multiple lines. + indent: number[]; } +// One place in a source file. export interface Point { - /** >= 1 */ + // Line in a source file (1-indexed integer). line: number; - /** >= 1 */ + + // Column in a source file (1-indexed integer). column: number; - /** >= 0 */ + + // Character in a source file (0-indexed integer). offset?: number; } +// Nodes containing other nodes. export interface Parent extends Node { + // List representing the children of a node. children: Node[]; } +// Nodes containing a value. export interface Literal extends Node { value: any; } diff --git a/types/unist/unist-tests.ts b/types/unist/unist-tests.ts index 3cb69bcc76..9ba2dc06d5 100644 --- a/types/unist/unist-tests.ts +++ b/types/unist/unist-tests.ts @@ -1,5 +1,3 @@ -import * as Unist from 'unist'; - const data: Unist.Data = { string: 'string', number: 1, From 2da1cef96f96157493360f98c607343ed90f6677 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Thu, 29 Nov 2018 19:40:11 -0300 Subject: [PATCH 675/799] fix: unist ts version --- types/unist/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/unist/index.d.ts b/types/unist/index.d.ts index 389b26e04f..55bea58e47 100644 --- a/types/unist/index.d.ts +++ b/types/unist/index.d.ts @@ -5,7 +5,7 @@ // Hernan Rajchert // Titus Wormer // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 3.1 +// TypeScript Version: 3.0 export as namespace Unist From 221e85cc38797c6ac9845c134d35a21d8c40249a Mon Sep 17 00:00:00 2001 From: Mark Wolff Date: Thu, 29 Nov 2018 14:49:05 -0800 Subject: [PATCH 676/799] Add properties and measurements to trackDependency --- types/applicationinsights-js/applicationinsights-js-tests.ts | 2 +- types/applicationinsights-js/index.d.ts | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/types/applicationinsights-js/applicationinsights-js-tests.ts b/types/applicationinsights-js/applicationinsights-js-tests.ts index c2adb63a30..ab52eb1537 100644 --- a/types/applicationinsights-js/applicationinsights-js-tests.ts +++ b/types/applicationinsights-js/applicationinsights-js-tests.ts @@ -47,7 +47,7 @@ appInsights = { startTrackEvent(name: string) { return null; }, stopTrackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }) { return null; }, trackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }) { return null; }, - trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number) { return null; }, + trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, properties?: Object, measurements?: Object) { return null; }, trackException(exception: Error, handledAt?: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }, severityLevel?: AI.SeverityLevel) { return null; }, trackMetric(name: string, average: number, sampleCount?: number, min?: number, max?: number, properties?: { [name: string]: string; }) { return null; }, trackTrace(message: string, properties?: { [name: string]: string; }, severityLevel?: AI.SeverityLevel) { return null; }, diff --git a/types/applicationinsights-js/index.d.ts b/types/applicationinsights-js/index.d.ts index ecfef55052..516556b8d3 100644 --- a/types/applicationinsights-js/index.d.ts +++ b/types/applicationinsights-js/index.d.ts @@ -732,8 +732,10 @@ declare module Microsoft.ApplicationInsights { * @param totalTime total request time * @param success indicates if the request was sessessful * @param resultCode response code returned by the dependency request + * @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty. + * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. */ - trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number): any; + trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, properties?: Object, measurements?: Object): any; /** * Log an exception you have caught. * @param exception An Error from a catch clause, or the string error message. From 5cce7fcb72b3a986f1315855d03503bb609263aa Mon Sep 17 00:00:00 2001 From: Mark Wolff Date: Thu, 29 Nov 2018 14:52:50 -0800 Subject: [PATCH 677/799] Add properties tests --- types/applicationinsights-js/applicationinsights-js-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/applicationinsights-js/applicationinsights-js-tests.ts b/types/applicationinsights-js/applicationinsights-js-tests.ts index ab52eb1537..d0e8b4eaaf 100644 --- a/types/applicationinsights-js/applicationinsights-js-tests.ts +++ b/types/applicationinsights-js/applicationinsights-js-tests.ts @@ -86,7 +86,7 @@ appInsights.trackTrace("message", null); appInsights.trackTrace("message", { a: '1', b: '2' }, AI.SeverityLevel.Error); // trackDependency -appInsights.trackDependency("id", "POST", "http://example.com/test/abc", "/test/abc", null, true, null); +appInsights.trackDependency("id", "POST", "http://example.com/test/abc", "/test/abc", null, true, null, {prop1: 'abc'}, {meas1: 4.5}); // flush appInsights.flush(); From c5896588bfef15fd92daee5d76d38c73006b5a5f Mon Sep 17 00:00:00 2001 From: Mark Wolff Date: Thu, 29 Nov 2018 15:30:05 -0800 Subject: [PATCH 678/799] Reduce line length --- types/applicationinsights-js/applicationinsights-js-tests.ts | 3 ++- types/applicationinsights-js/index.d.ts | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/types/applicationinsights-js/applicationinsights-js-tests.ts b/types/applicationinsights-js/applicationinsights-js-tests.ts index d0e8b4eaaf..de6de9a2c6 100644 --- a/types/applicationinsights-js/applicationinsights-js-tests.ts +++ b/types/applicationinsights-js/applicationinsights-js-tests.ts @@ -47,7 +47,8 @@ appInsights = { startTrackEvent(name: string) { return null; }, stopTrackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }) { return null; }, trackEvent(name: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }) { return null; }, - trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, properties?: Object, measurements?: Object) { return null; }, + trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, + resultCode: number, properties?: { [name: string]: string }, measurements?: { [name: string]: number }) { return null; }, trackException(exception: Error, handledAt?: string, properties?: { [name: string]: string; }, measurements?: { [name: string]: number; }, severityLevel?: AI.SeverityLevel) { return null; }, trackMetric(name: string, average: number, sampleCount?: number, min?: number, max?: number, properties?: { [name: string]: string; }) { return null; }, trackTrace(message: string, properties?: { [name: string]: string; }, severityLevel?: AI.SeverityLevel) { return null; }, diff --git a/types/applicationinsights-js/index.d.ts b/types/applicationinsights-js/index.d.ts index 516556b8d3..2959e6da39 100644 --- a/types/applicationinsights-js/index.d.ts +++ b/types/applicationinsights-js/index.d.ts @@ -735,7 +735,8 @@ declare module Microsoft.ApplicationInsights { * @param properties map[string, string] - additional data used to filter events and metrics in the portal. Defaults to empty. * @param measurements map[string, number] - metrics associated with this event, displayed in Metrics Explorer on the portal. Defaults to empty. */ - trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, properties?: Object, measurements?: Object): any; + trackDependency(id: string, method: string, absoluteUrl: string, pathName: string, totalTime: number, success: boolean, resultCode: number, + properties?: { [name: string]: string }, measurements?: { [name: string]: number }): any; /** * Log an exception you have caught. * @param exception An Error from a catch clause, or the string error message. From 09b6f76746fa597d9bbbfea4cc32806d17349cf8 Mon Sep 17 00:00:00 2001 From: Law Smith Date: Thu, 29 Nov 2018 16:45:28 -0800 Subject: [PATCH 679/799] Added support for params when starting sagaTester. --- types/redux-saga-tester/index.d.ts | 28 +++---- types/redux-saga-tester/package.json | 7 ++ .../redux-saga-tester-tests.ts | 74 ++++++++++++------- 3 files changed, 65 insertions(+), 44 deletions(-) create mode 100644 types/redux-saga-tester/package.json diff --git a/types/redux-saga-tester/index.d.ts b/types/redux-saga-tester/index.d.ts index fda97e494b..5778edf1bd 100644 --- a/types/redux-saga-tester/index.d.ts +++ b/types/redux-saga-tester/index.d.ts @@ -1,27 +1,19 @@ // Type definitions for redux-saga-tester 1.0 // Project: https://github.com/wix/redux-saga-tester#readme -// Definitions by: Ben Lorantfy +// Definitions by: Ben Lorantfy , Law Smith // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 +// TypeScript Version: 2.4 + +import {Task} from 'redux-saga'; +import {AnyAction, Middleware, Reducer, ReducersMapObject} from 'redux'; -export interface AnyAction { - type: string; - [key: string]: any; -} -export type Reducer = (state: object, action: AnyAction) => object; -export interface ReducerMap { - [key: string]: Reducer; -} -export type ReduxMiddleware = (options: { dispatch: (action: AnyAction) => void, getState: () => object }) - => (next: (action: AnyAction) => any) - => any; export type SagaFunction = (...args: any[]) => any; -export interface SagaTesterOptions { +export interface SagaTesterOptions { initialState?: StateType; - reducers?: ReducerMap|Reducer; - middlewares?: ReduxMiddleware[]; - combineReducers?: (map: ReducerMap) => Reducer; + reducers?: ReducersMapObject | Reducer; + middlewares?: Middleware[]; + combineReducers?: (map: ReducersMapObject) => Reducer; ignoreReduxActions?: boolean; options?: object; } @@ -32,7 +24,7 @@ export default class SagaTester { /** * Starts execution of the provided saga. */ - start(saga: SagaFunction): void; + start(saga: SagaFunction, ...args: any[]): Task; /** * Dispatches an action to the redux store. diff --git a/types/redux-saga-tester/package.json b/types/redux-saga-tester/package.json new file mode 100644 index 0000000000..8d41143894 --- /dev/null +++ b/types/redux-saga-tester/package.json @@ -0,0 +1,7 @@ +{ + "private": true, + "dependencies": { + "redux": "^3.7.2", + "redux-saga": "^0.15.3" + } +} diff --git a/types/redux-saga-tester/redux-saga-tester-tests.ts b/types/redux-saga-tester/redux-saga-tester-tests.ts index 0dba716533..4cd9c001c9 100644 --- a/types/redux-saga-tester/redux-saga-tester-tests.ts +++ b/types/redux-saga-tester/redux-saga-tester-tests.ts @@ -2,62 +2,79 @@ import SagaTester from 'redux-saga-tester'; // constructor with all options new SagaTester({ - initialState: { - orders: [], - }, - reducers: { - orders: (state, action) => state, - }, - middlewares: [ - ({ dispatch, getState }) => (next) => (action: { type: string }) => { - dispatch({ type: 'BLA' }); - getState(); + initialState: { + orders: [], + }, + reducers: { + orders: (state, action) => state, + }, + middlewares: [ + ({dispatch, getState}) => (next) => (action) => { + dispatch({type: 'BLA'}); + getState(); - return next(action); + return next(action); + }, + ], + ignoreReduxActions: false, + options: { + a: 23, }, - ], - ignoreReduxActions: false, - options: { - a: 23, - }, }); // constructor with function as reducers new SagaTester({ - reducers: (state, action) => state, + reducers: (state = {}, action) => state, +}); + +// constructor with reducer map +new SagaTester({ + reducers: { + a: (state, action) => state, + b: (state, action) => state, + c: (state, action) => state, + } }); // constructor with no options interface MockStateType { - orders: Array<{ name: string }>; + orders: Array<{ name: string }>; } -const sagaTester = new SagaTester({ initialState: { orders: [] }}); + +const sagaTester = new SagaTester({initialState: {orders: []}}); // start function* fakeSaga() { - return 23; + return 23; +} + +function* fakeSagaWithParams(param1: string, param2: number) { + return param1.length > param2 } sagaTester.start(fakeSaga); +sagaTester.start(fakeSagaWithParams, 'foo', 3); // dispatch -sagaTester.dispatch({ type: 'LOAD_ORDERS', orders: [] }); +sagaTester.dispatch({type: 'LOAD_ORDERS', orders: []}); // updateState -sagaTester.updateState({ orders: [] }); +sagaTester.updateState({orders: []}); // getState sagaTester.getState().orders; // waitFor -sagaTester.waitFor('LOAD_ORDERS').then(() => {}); -sagaTester.waitFor('LOAD_ORDERS', true).then(() => {}); +sagaTester.waitFor('LOAD_ORDERS').then(() => { +}); +sagaTester.waitFor('LOAD_ORDERS', true).then(() => { +}); // wasCalled -sagaTester.wasCalled("LOAD_ORDERS"); +sagaTester.wasCalled('LOAD_ORDERS'); // numCalled -sagaTester.numCalled("LOAD_ORDERS") === 1; +sagaTester.numCalled('LOAD_ORDERS') === 1; // getLatestCalledAction sagaTester.getLatestCalledAction().type; @@ -68,3 +85,8 @@ sagaTester.getCalledActions()[0].type; // getCalledActions sagaTester.reset(); sagaTester.reset(true); + +// getState +const state = sagaTester.getState(); +state.orders.length; +state.orders[0].name; From 8d5940c36bdd76ba364fa79271aff55cc8e0fc48 Mon Sep 17 00:00:00 2001 From: Law Smith Date: Thu, 29 Nov 2018 17:50:40 -0800 Subject: [PATCH 680/799] Fixing linter errors. --- types/redux-saga-tester/index.d.ts | 4 ++-- types/redux-saga-tester/redux-saga-tester-tests.ts | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/types/redux-saga-tester/index.d.ts b/types/redux-saga-tester/index.d.ts index 5778edf1bd..d7772626ef 100644 --- a/types/redux-saga-tester/index.d.ts +++ b/types/redux-saga-tester/index.d.ts @@ -4,8 +4,8 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.4 -import {Task} from 'redux-saga'; -import {AnyAction, Middleware, Reducer, ReducersMapObject} from 'redux'; +import { Task } from 'redux-saga'; +import { AnyAction, Middleware, Reducer, ReducersMapObject } from 'redux'; export type SagaFunction = (...args: any[]) => any; diff --git a/types/redux-saga-tester/redux-saga-tester-tests.ts b/types/redux-saga-tester/redux-saga-tester-tests.ts index 4cd9c001c9..48eb490d0a 100644 --- a/types/redux-saga-tester/redux-saga-tester-tests.ts +++ b/types/redux-saga-tester/redux-saga-tester-tests.ts @@ -49,7 +49,7 @@ function* fakeSaga() { } function* fakeSagaWithParams(param1: string, param2: number) { - return param1.length > param2 + return param1.length > param2; } sagaTester.start(fakeSaga); From 5610636ad2e5dbf618f1ed8db8acb4d0407305a6 Mon Sep 17 00:00:00 2001 From: Matt McCutchen Date: Fri, 30 Nov 2018 01:24:18 -0500 Subject: [PATCH 681/799] react: Improve type checking of component static properties. (#30730) - Copy properties from ComponentClass to the Component class. - Recommend the react-typescript-helpers package for checking the defaultProps and propTypes at a component definition. - As a fallback, have JSX.LibraryManagedAttributes check the defaultProps and propTypes every time a component is used. - Fix test failures in dependent packages. Fixes #28515. Fixes #16967. --- .../components/responsive.d.ts | 30 --- types/react-select/lib/components/Menu.d.ts | 6 - .../test/examples/CustomNoOptionsMessage.tsx | 7 +- types/react-virtualized/dist/es/List.d.ts | 2 +- types/react-virtualized/dist/es/Table.d.ts | 79 +------ types/react/index.d.ts | 126 ++++++++--- types/react/test/managedAttributes.tsx | 208 ++++++++++-------- types/theming/index.d.ts | 2 +- 8 files changed, 225 insertions(+), 235 deletions(-) diff --git a/types/react-foundation/components/responsive.d.ts b/types/react-foundation/components/responsive.d.ts index 94a915f2c8..9b3a8361ed 100644 --- a/types/react-foundation/components/responsive.d.ts +++ b/types/react-foundation/components/responsive.d.ts @@ -24,36 +24,6 @@ export declare class ResponsiveNavigation extends Component; - alignX: PropTypes.Requireable; - alignY: PropTypes.Requireable; - selfAlignX: PropTypes.Requireable; - selfAlignY: PropTypes.Requireable; - centerAlign: PropTypes.Requireable; - flexContainer: PropTypes.Requireable; - flexDirRow: PropTypes.Requireable; - flexDirRowRev: PropTypes.Requireable; - flexDirCol: PropTypes.Requireable; - flexDirColRev: PropTypes.Requireable; - flexChild: PropTypes.Requireable; - flexOrder: PropTypes.Requireable; - flexOrderSmall: PropTypes.Requireable; - flexOrderMedium: PropTypes.Requireable; - flexOrderLarge: PropTypes.Requireable; - showFor: PropTypes.Requireable; - showOnlyFor: PropTypes.Requireable; - hideFor: PropTypes.Requireable; - hideOnlyFor: PropTypes.Requireable; - isHidden: PropTypes.Requireable; - isInvisible: PropTypes.Requireable; - showForLandscape: PropTypes.Requireable; - showForPortrait: PropTypes.Requireable; - showForSr: PropTypes.Requireable; - showOnFocus: PropTypes.Requireable; - isClearfix: PropTypes.Requireable; - float: PropTypes.Requireable; - }; static defaultProps: { breakpoint: number; }; diff --git a/types/react-select/lib/components/Menu.d.ts b/types/react-select/lib/components/Menu.d.ts index 387b538882..8c6e5fb6c8 100644 --- a/types/react-select/lib/components/Menu.d.ts +++ b/types/react-select/lib/components/Menu.d.ts @@ -67,9 +67,6 @@ export type MenuProps = CommonProps & { export function menuCSS(state: MenuState): React.CSSProperties; export class Menu extends Component, MenuState> { - static contextTypes: { - getPortalPlacement: (state: MenuState) => void, - }; getPlacement: (ref: ElementRef) => void; getState: () => MenuProps & MenuState; } @@ -146,9 +143,6 @@ interface PortalStyleArgs { export function menuPortalCSS(args: PortalStyleArgs): React.CSSProperties; export class MenuPortal extends Component, MenuPortalState> { - static childContextTypes: { - getPortalPlacement: (state: MenuState) => void, - }; getChildContext(): { getPortalPlacement: (state: MenuState) => void; }; diff --git a/types/react-select/test/examples/CustomNoOptionsMessage.tsx b/types/react-select/test/examples/CustomNoOptionsMessage.tsx index 6bea4cb47a..3896272d5b 100644 --- a/types/react-select/test/examples/CustomNoOptionsMessage.tsx +++ b/types/react-select/test/examples/CustomNoOptionsMessage.tsx @@ -18,7 +18,12 @@ const NoOptionsMessage = (props: any) => { export default class CustomNoOptionsMessage extends React.Component { render() { return ( - ({ ...base, ...msgStyles }) }} diff --git a/types/react-virtualized/dist/es/List.d.ts b/types/react-virtualized/dist/es/List.d.ts index 9de78e4066..57e00ae909 100644 --- a/types/react-virtualized/dist/es/List.d.ts +++ b/types/react-virtualized/dist/es/List.d.ts @@ -30,7 +30,7 @@ export type ListProps = GridCoreProps & { /** Height constraint for list (determines how many actual rows are rendered) */ height: number; /** Optional renderer to be used in place of rows when rowCount is 0 */ - noRowsRenderer?: () => JSX.Element | null; + noRowsRenderer?: () => JSX.Element; /** * Callback invoked with information about the slice of rows that were just rendered. * ({ startIndex, stopIndex }): void diff --git a/types/react-virtualized/dist/es/Table.d.ts b/types/react-virtualized/dist/es/Table.d.ts index e9a09dae4c..b66fac389b 100644 --- a/types/react-virtualized/dist/es/Table.d.ts +++ b/types/react-virtualized/dist/es/Table.d.ts @@ -152,6 +152,26 @@ export type ColumnProps = { width: number; }; export class Column extends Component { + static propTypes: { + "aria-label": Requireable; + cellDataGetter: Requireable; + cellRenderer: Requireable; + className: Requireable; + columnData: Requireable; + dataKey: Validator; + disableSort: Requireable; + flexGrow: Requireable; + flexShrink: Requireable; + headerClassName: Requireable; + headerRenderer: Validator; + label: Requireable; + maxWidth: Requireable; + minWidth: Requireable; + style: Requireable; + width: Validator; + id: Requireable; + }; + static defaultProps: { cellDataGetter: TableCellDataGetter; cellRenderer: TableCellRenderer; @@ -358,6 +378,63 @@ export const SortIndicator: React.StatelessComponent<{ * This component expects explicit width, height, and padding parameters. */ export class Table extends PureComponent { + static propTypes: { + "aria-label": Requireable; + autoHeight: Requireable; + children: Validator; + className: Requireable; + disableHeader: Requireable; + estimatedRowSize: Validator; + gridClassName: Requireable; + gridStyle: Requireable; + headerClassName: Requireable; + headerHeight: Validator; + headerRowRenderer: Requireable; + headerStyle: Requireable; + height: Validator; + id: Requireable; + noRowsRenderer: Requireable<() => JSX.Element>; + onHeaderClick: Requireable< + (params: HeaderMouseEventHandlerParams) => void + >; + onRowClick: Requireable<(params: RowMouseEventHandlerParams) => void>; + onRowDoubleClick: Requireable< + (params: RowMouseEventHandlerParams) => void + >; + onRowMouseOut: Requireable< + (params: RowMouseEventHandlerParams) => void + >; + onRowMouseOver: Requireable< + (params: RowMouseEventHandlerParams) => void + >; + onRowsRendered: Requireable< + (params: RowMouseEventHandlerParams) => void + >; + onScroll: Requireable<(params: ScrollEventData) => void>; + overscanRowCount: Validator; + rowClassName: Requireable string)>; + rowGetter: Validator<(params: Index) => any>; + rowHeight: Validator number)>; + rowCount: Validator; + rowRenderer: Requireable<(props: TableRowProps) => React.ReactNode>; + rowStyle: Validator< + React.CSSProperties | ((params: Index) => React.CSSProperties) + >; + scrollToAlignment: Validator; + scrollToIndex: Validator; + scrollTop: Requireable; + sort: Requireable< + ( + params: { sortBy: string; sortDirection: SortDirectionType } + ) => void + >; + sortBy: Requireable; + sortDirection: Validator; + style: Requireable; + tabIndex: Requireable; + width: Validator; + }; + static defaultProps: { disableHeader: false; estimatedRowSize: 30; @@ -368,7 +445,7 @@ export class Table extends PureComponent { onScroll: () => null; overscanRowCount: 10; rowRenderer: TableRowRenderer; - headerRowRenderer: TableHeaderRowRenderer; + headerRowRenderer: TableHeaderRenderer; rowStyle: {}; scrollToAlignment: "auto"; scrollToIndex: -1; diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 5cefb7fca2..f525d7838c 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -421,34 +421,6 @@ declare namespace React { refs: { [key: string]: ReactInstance }; - - // Static properties copied from ComponentClass interface. - /** - * The validity of the type of `propTypes` cannot be checked - * automatically at the definition of a component class because the - * required type depends on `P`. We recommend checking it using - * `asPropTypes` from the `react-typescript-helpers` package. If you - * don't do that, then the type will still be checked by - * JSX.LibraryManagedAttributes every time the component is used, - * assuming you use TypeScript 3.0 or newer. - */ - // Note: `propTypes` and `defaultProps` need to be `any` so that a - // component class that does not redeclare them is assignable to - // `ComponentClass

`. - static propTypes?: any; - static contextTypes?: ValidationMap; - static childContextTypes?: ValidationMap; - /** - * The validity of the type of `defaultProps` cannot be checked - * automatically at the definition of a component class because the - * required type depends on `P`. We recommend checking it using - * `asDefaultProps` from the `react-typescript-helpers` package. If you - * don't do that, then the type will still be checked by - * JSX.LibraryManagedAttributes every time the component is used, - * assuming you use TypeScript 3.0 or newer. - */ - static defaultProps?: any; - static displayName?: string; } class PureComponent

extends Component { } @@ -2664,77 +2636,31 @@ declare namespace React { */ componentStack: string; } - - const Invalid_propTypes: unique symbol; - /** - * Dummy interface that is intersected into the props type of a component on - * use to generate an error if the component's `propTypes` static property - * is invalid. In most cases, you can get more information about the - * problem with the `propTypes` by trying to assign the component to a - * variable of type `React.ComponentType

` where `P` is the appropriate - * props type. You can bypass the type checking of `propTypes` by defining - * a static property named `bypassPropTypesTypecheck`. - */ - interface Invalid_propTypes { - [Invalid_propTypes]: never; - } - - const Invalid_defaultProps: unique symbol; - /** - * Dummy interface that is intersected into the props type of a component on - * use to generate an error if the component's `defaultProps` static - * property is invalid. In most cases, you can get more information about - * the problem with the `defaultProps` by trying to assign the component to - * a variable of type `React.ComponentType

` where `P` is the appropriate - * props type. You can bypass the type checking of `defaultProps` by - * defining a static property named `bypassDefaultPropsTypecheck`. - */ - interface Invalid_defaultProps { - [Invalid_defaultProps]: never; - } - - // For a component class, the P passed to JSX.LibraryManagedAttributes is - // based on the `props` property and includes `children` regardless of - // whether the original props type (the `P` type argument to - // React.Component) does. However, it's common for component classes not - // to list `children` in the `propTypes` if the original props type did not - // include `children`. We accommodate that here by making the validator for - // `children` optional. - type ValidationMapWithOptionalChildren

= - ValidationMap>> & - Partial>>>; - - // Explicitly check for excess properties in CheckPropTypes and - // CheckDefaultProps because by the time we get to - // JSX.LibraryManagedAttributes, we have lost the opportunity to do an - // excess properties check on the original object literal. - - type CheckPropTypes = - // This condition attempts to single out `T = any`, which needs to bypass the rest of the check - // because `keyof T` would come out as not extending `keyof P`. - T extends typeof Invalid_propTypes ? {} : - [keyof T, T] extends [keyof P, ValidationMapWithOptionalChildren

] ? {} : Invalid_propTypes; - - type CheckDefaultProps = - D extends typeof Invalid_defaultProps ? {} : - [keyof D, D] extends [keyof P, Partial

] ? {} : Invalid_defaultProps; - - // Any prop that has a default prop becomes optional, but its type is unchanged - // If declared props have indexed properties, ignore default props entirely as keyof gets widened - // Wrap in an outer-level conditional type to allow distribution over props that are unions - type Defaultize = P extends any - ? string extends keyof P ? P : - & Pick> - & Partial>> - : never; - - type ReactManagedAttributes = - (C extends { propTypes: infer T; } - ? (C extends { bypassPropTypesTypecheck: {}; } ? {} : CheckPropTypes) : {}) & - (C extends { defaultProps: infer D; } - ? (C extends { bypassDefaultPropsTypecheck: {}; } ? {} : CheckDefaultProps) & Defaultize : P); } +// Declared props take priority over inferred props +// If declared props have indexed properties, ignore inferred props entirely as keyof gets widened +type MergePropTypes = P & Pick>; + +// Any prop that has a default prop becomes optional, but its type is unchanged +// Undeclared default props are augmented into the resulting allowable attributes +// If declared props have indexed properties, ignore default props entirely as keyof gets widened +// Wrap in an outer-level conditional type to allow distribution over props that are unions +type Defaultize = P extends any + ? string extends keyof P ? P : + & Pick> + & Partial>> + & Partial>> + : never; + +type ReactManagedAttributes = C extends { propTypes: infer T; defaultProps: infer D; } + ? Defaultize>, D> + : C extends { propTypes: infer T; } + ? MergePropTypes> + : C extends { defaultProps: infer D; } + ? Defaultize + : P; + declare global { namespace JSX { // tslint:disable-next-line:no-empty-interface @@ -2749,9 +2675,9 @@ declare global { // let's assume it's reasonable to do a single React.lazy() around a single React.memo() / vice-versa type LibraryManagedAttributes = C extends React.MemoExoticComponent | React.LazyExoticComponent ? T extends React.MemoExoticComponent | React.LazyExoticComponent - ? React.ReactManagedAttributes - : React.ReactManagedAttributes - : React.ReactManagedAttributes; + ? ReactManagedAttributes + : ReactManagedAttributes + : ReactManagedAttributes; // tslint:disable-next-line:no-empty-interface interface IntrinsicAttributes extends React.Attributes { } diff --git a/types/react/test/managedAttributes.tsx b/types/react/test/managedAttributes.tsx index a4213c58b1..1e0e8226d9 100644 --- a/types/react/test/managedAttributes.tsx +++ b/types/react/test/managedAttributes.tsx @@ -1,18 +1,14 @@ interface LeaveMeAloneDtslint { foo: string; } -// Re-enable when we move @types/react to TS 3.0 (except for the tests marked as -// requiring TS >= 3.2) -// -// In the meantime, these tests can be run manually by uncommenting the code -// below and running `dtslint --onlyTestTsNext`. +// // Re-enable when we move @types/react to TS 3.0 // import * as React from 'react'; // import * as PropTypes from 'prop-types'; // interface Props { -// bool?: boolean | null; +// bool?: boolean; // fnc: () => any; // node?: React.ReactNode; -// num?: number | null; +// num?: number; // reqNode: NonNullable; // str: string; // } @@ -22,12 +18,14 @@ interface LeaveMeAloneDtslint { foo: string; } // fnc: PropTypes.func.isRequired, // node: PropTypes.node, // num: PropTypes.number, -// reqNode: PropTypes.node.isRequired, // str: PropTypes.string.isRequired, +// extraStr: PropTypes.string.isRequired, +// extraNum: PropTypes.number // }; // const defaultProps = { // fnc: (() => 'abc') as () => any, +// extraBool: false, // reqNode: 'text_node' as NonNullable // }; @@ -38,12 +36,39 @@ interface LeaveMeAloneDtslint { foo: string; } // const annotatedPropTypesAndDefaultPropsTests = [ // // $ExpectError -// , // str is required -// , +// , // str and extraStr are required +// , // // $ExpectError // , // num type mismatch // } +// num={0} +// reqNode={} +// str='abc' +// /> +// ]; + +// class UnannotatedPropTypesAndDefaultProps extends React.Component { +// static propTypes = propTypes; +// static defaultProps = defaultProps; +// } + +// const unannotatedPropTypesAndDefaultPropsTests = [ +// // $ExpectError +// , // stra and extraStr are required +// , +// // $ExpectError +// , // extraBool type mismatch +// } // num={0} @@ -58,14 +83,16 @@ interface LeaveMeAloneDtslint { foo: string; } // const annotatedPropTypesTests = [ // // $ExpectError -// , // str, reqNode and fnc are required -// } />, +// , // str, extraStr, reqNode and fnc are required +// } />, // // $ExpectError -// } extraBool={false} />, // extraBool doesn't exist +// } extraBool={false} />, // extraBool doesn't exist // // $ExpectError -// } num='abc' />, // num type mismatch +// } num='abc' />, // num type mismatch // } // num={0} @@ -74,6 +101,29 @@ interface LeaveMeAloneDtslint { foo: string; } // /> // ]; +// class UnannotatedPropTypes extends React.Component { +// static propTypes = propTypes; +// } + +// const unannotatedPropTypesTests = [ +// // $ExpectError +// , // str, extraStr and fnc are required +// , +// // $ExpectError +// } />, // reqNode doesn't exist +// // $ExpectError +// } num='abc' />, // num type mismatch +// } +// num={0} +// str='abc' +// /> +// ]; + // class AnnotatedDefaultProps extends React.Component { // static defaultProps = defaultProps; // } @@ -87,6 +137,7 @@ interface LeaveMeAloneDtslint { foo: string; } // { }} />, // str type mismatch // // ]; +// class UnannotatedDefaultProps extends React.Component { +// static defaultProps = defaultProps; +// } + +// const unannotatedDefaultPropsTests = [ +// , +// } +// /> +// ]; + // class ComponentWithNoDefaultProps extends React.Component {} -// function FunctionalComponent(props: Props) { return <>{props.reqNode}; } +// function FunctionalComponent(props: Props) { return <>{props.reqNode} } // FunctionalComponent.defaultProps = defaultProps; // const functionalComponentTests = [ // // $ExpectError // , -// // NOTE: This test requires TypeScript >= 3.2, which honors JSX.LibraryManagedAttributes for function components. +// // This is possibly a bug/limitation of TS +// // Even if JSX.LibraryManagedAttributes returns the correct type, it doesn't seem to work with non-classes +// // This also doesn't work with things typed React.SFC

because defaultProps will always be Partial

+// // $ExpectError // // ]; @@ -115,28 +182,27 @@ interface LeaveMeAloneDtslint { foo: string; } // const memoTests = [ // // $ExpectError // , -// // Requires TypeScript >= 3.2; see comment re FunctionalComponent above +// // $ExpectError won't work as long as FunctionalComponent doesn't work either // , // // $ExpectError // , // , -// // Requires TypeScript >= 3.2; see comment re FunctionalComponent above +// // $ExpectError this doesn't work despite JSX.LibraryManagedAttributes returning the correct type // , -// // Requires TypeScript >= 3.2; see comment re FunctionalComponent above +// // $ExpectError won't work as long as FunctionalComponent doesn't work either // , // // $ExpectError // , -// // Requires TypeScript >= 3.2; see comment re FunctionalComponent above +// // $ExpectError this doesn't work despite JSX.LibraryManagedAttributes returning the correct type // // ]; -// // $ExpectType Pick & Partial> // type AnnotatedDefaultPropsLibraryManagedAttributes = JSX.LibraryManagedAttributes; -// // $ExpectType Pick & Partial> +// // $ExpectType AnnotatedDefaultPropsLibraryManagedAttributes // type FunctionalComponentLibraryManagedAttributes = JSX.LibraryManagedAttributes; -// // $ExpectType Pick & Partial> +// // $ExpectType FunctionalComponentLibraryManagedAttributes // type MemoFunctionalComponentLibraryManagedAttributes = JSX.LibraryManagedAttributes; -// // $ExpectType Pick & Partial> +// // $ExpectType FunctionalComponentLibraryManagedAttributes // type LazyMemoFunctionalComponentLibraryManagedAttributes = JSX.LibraryManagedAttributes; // const ForwardRef = React.forwardRef((props: Props, ref: React.Ref) => ( @@ -152,97 +218,7 @@ interface LeaveMeAloneDtslint { foo: string; } // reqNode={} // str='' // />, -// // the type of ForwardRef.defaultProps stays Partial

anyway even if assigned -// // $ExpectError +// // same bug as MemoFunctionalComponent and React.SFC-typed things +// // $ExpectError the type of ForwardRef.defaultProps stays Partial

anyway even if assigned // // ]; - -// const wrongDefaultProps = { -// fnc: 42 -// }; -// class WrongDefaultPropsComponent extends React.Component { -// static defaultProps = wrongDefaultProps; -// } -// const wrongDefaultPropsComponentTests = [ -// // $ExpectError -// undefined} reqNode="text" str="str" /> -// ]; -// // $ExpectError -// const investigateWrongDefaultPropsComponent: React.ComponentType = WrongDefaultPropsComponent; - -// const excessDefaultProps = { -// another: 43 -// }; -// class ExcessDefaultPropsComponent extends React.Component { -// static defaultProps = excessDefaultProps; -// } -// const excessDefaultPropsComponentTests = [ -// // $ExpectError -// undefined} reqNode="text" str="str" /> -// ]; -// // $ExpectError -// const investigateExcessDefaultPropsComponent: React.ComponentType = ExcessDefaultPropsComponent; - -// const wrongPropTypes = { -// bool: PropTypes.bool, -// fnc: PropTypes.number.isRequired, -// node: PropTypes.node, -// num: PropTypes.number, -// reqNode: PropTypes.node.isRequired, -// str: PropTypes.string.isRequired, -// }; -// class WrongPropTypesComponent extends React.Component { -// static propTypes = wrongPropTypes; -// } -// const wrongPropTypesComponentTests = [ -// // $ExpectError -// undefined} reqNode="text" str="str" /> -// ]; - -// const incompletePropTypes = { -// bool: PropTypes.bool, -// node: PropTypes.node, -// num: PropTypes.number, -// reqNode: PropTypes.node.isRequired, -// str: PropTypes.string.isRequired, -// }; -// class IncompletePropTypesComponent extends React.Component { -// static propTypes = incompletePropTypes; -// } -// const incompletePropTypesComponentTests = [ -// // $ExpectError -// undefined} reqNode="text" str="str" /> -// ]; - -// const excessPropTypes = { -// another: PropTypes.number.isRequired, -// bool: PropTypes.bool, -// fnc: PropTypes.func.isRequired, -// node: PropTypes.node, -// num: PropTypes.number, -// reqNode: PropTypes.node.isRequired, -// str: PropTypes.string.isRequired, -// }; -// class ExcessPropTypesComponent extends React.Component { -// static propTypes = excessPropTypes; -// } -// const ExcessPropTypesComponentTests = [ -// // $ExpectError -// undefined} reqNode="text" str="str" /> -// ]; - -// class WrongDefaultPropsSuppressedComponent extends React.Component { -// static defaultProps = wrongDefaultProps; -// static bypassDefaultPropsTypecheck = true; -// } -// const wrongDefaultPropsSuppressedComponentTests = [ -// undefined} reqNode="text" str="str" /> -// ]; - -// class WrongPropTypesSuppressedComponent extends React.Component { -// static propTypes = wrongPropTypes; -// static bypassPropTypesTypecheck = true; -// } -// const wrongPropTypesSuppressedComponentTests = [ -// undefined} reqNode="text" str="str" /> -// ]; diff --git a/types/theming/index.d.ts b/types/theming/index.d.ts index d2c0d1ee40..e2525b3ce6 100644 --- a/types/theming/index.d.ts +++ b/types/theming/index.d.ts @@ -40,7 +40,7 @@ export interface ThemeListener { callback: (theme: Theme) => void ): SubscriptionId; unsubscribe(context: ContextWithTheme, id: SubscriptionId): void; - contextTypes: React.ValidationMap>; + contextTypes: React.ValidationMap; } /** * ThemeListener for the default channel From 1916f716dc67551c639b323a14064c7b9f74562e Mon Sep 17 00:00:00 2001 From: Wayne Carson Date: Fri, 30 Nov 2018 15:41:13 -0800 Subject: [PATCH 698/799] Added flush() method to debounce (see https://git.io/fpoYM) --- types/debounce/debounce-tests.ts | 3 +++ types/debounce/index.d.ts | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/types/debounce/debounce-tests.ts b/types/debounce/debounce-tests.ts index 4acff7c446..5f0463a4c1 100644 --- a/types/debounce/debounce-tests.ts +++ b/types/debounce/debounce-tests.ts @@ -14,6 +14,9 @@ const imm1: number = (debounce((x: number) => x * 2, 100, true))(2); const clearable = debounce(doThings); clearable.clear(); +const flushable = debounce(doThings); +flushable.flush(); + // Intentionally asserts that the member variable has all the same benefits as the direct export. // Eventually, if debounce stop supporting the CommonJS-only module calling (`require("debounce")(...)`), // we can remove this and change the top import&require to `import { debounce } from "debounce";`. diff --git a/types/debounce/index.d.ts b/types/debounce/index.d.ts index fa244351d6..bef99f2c86 100644 --- a/types/debounce/index.d.ts +++ b/types/debounce/index.d.ts @@ -1,13 +1,15 @@ -// Type definitions for debounce 3.0 +// Type definitions for debounce 1.2.0 // Project: https://github.com/component/debounce // Definitions by: Denis Sokolov // Josh Goldberg +// Wayne Carson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace _debounce { const debounce: typeof _debounce; } -declare function _debounce(f: A, interval?: number, immediate?: boolean): A & { clear(): void; }; +declare function _debounce(f: A, interval?: number, immediate?: boolean): A & { clear(): void; } + & { flush(): void }; export = _debounce; From 6645ba33d52edd3303ae58bf81ce6b29042bd924 Mon Sep 17 00:00:00 2001 From: Wayne Carson Date: Fri, 30 Nov 2018 16:12:54 -0800 Subject: [PATCH 699/799] Fixed DT header version convention issue. --- types/debounce/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/debounce/index.d.ts b/types/debounce/index.d.ts index bef99f2c86..e561cb51fe 100644 --- a/types/debounce/index.d.ts +++ b/types/debounce/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for debounce 1.2.0 +// Type definitions for debounce 1.2 // Project: https://github.com/component/debounce // Definitions by: Denis Sokolov // Josh Goldberg From f86366a401ca98ebaa7aa3ec4a0ef5391970eee7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Den=C3=A8le?= Date: Sat, 1 Dec 2018 02:44:09 +0100 Subject: [PATCH 700/799] Prefer notation without arrow function --- types/puppeteer/index.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/types/puppeteer/index.d.ts b/types/puppeteer/index.d.ts index 202cc05181..813f256835 100644 --- a/types/puppeteer/index.d.ts +++ b/types/puppeteer/index.d.ts @@ -2061,10 +2061,10 @@ export interface ConnectOptions { } export interface ConnectionTransport { - send: (message: string) => void; - close: () => void; - onmessage?: (message: string) => void; - onclose?: () => void; + send(message: string): void; + close(): void; + onmessage?(message: string): void; + onclose?(): void; } export interface CDPSession extends EventEmitter { From 0a82ed88126e5b99a876aa5514ce2beedb9f441a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Den=C3=A8le?= Date: Sat, 1 Dec 2018 02:45:40 +0100 Subject: [PATCH 701/799] Remove empty line --- types/puppeteer/index.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/puppeteer/index.d.ts b/types/puppeteer/index.d.ts index 813f256835..fe4fb0d14a 100644 --- a/types/puppeteer/index.d.ts +++ b/types/puppeteer/index.d.ts @@ -2033,7 +2033,6 @@ export interface BrowserOptions { */ isMobile?: boolean; /** - * * Specifies if viewport supports touch events. * @default false */ From b506cfa9c04bbeff9866b50a0712808b45ea171b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Den=C3=A8le?= Date: Sat, 1 Dec 2018 03:01:35 +0100 Subject: [PATCH 702/799] Define type for layout dimension --- types/puppeteer/index.d.ts | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/types/puppeteer/index.d.ts b/types/puppeteer/index.d.ts index fe4fb0d14a..1b675b20c5 100644 --- a/types/puppeteer/index.d.ts +++ b/types/puppeteer/index.d.ts @@ -513,6 +513,9 @@ export interface DirectNavigationOptions extends NavigationOptions { referer?: string; } +/** Accepts values labeled with units. If number, treat as pixels. */ +export type LayoutDimension = string | number; + export type PDFFormat = | "Letter" | "Legal" @@ -580,22 +583,21 @@ export interface PDFOptions { * @default 'Letter' */ format?: PDFFormat; - /** Paper width, accepts values labeled with units. Treat numbers as pixel values */ - width?: string | number; - /** Paper height, accepts values labeled with units. Treat numbers as pixel values */ - height?: string | number; - /** Paper margins, defaults to none. */ + /** Paper width. */ + width?: LayoutDimension; + /** Paper height. */ + height?: LayoutDimension; + /** Paper margins, defaults to none. */ margin?: { - /** Top margin, accepts values labeled with units. Treat numbers as pixel values */ - top?: string | number; - /** Right margin, accepts values labeled with units. Treat numbers as pixel values */ - right?: string | number; - /** Bottom margin, accepts values labeled with units. Treat numbers as pixel values */ - bottom?: string | number; - /** Left margin, accepts values labeled with units. Treat numbers as pixel values */ - left?: string | number; + /** Top margin. */ + top?: LayoutDimension; + /** Right margin. */ + right?: LayoutDimension; + /** Bottom margin. */ + bottom?: LayoutDimension; + /** Left margin. */ + left?: LayoutDimension; }; - /** * Give any CSS @page size declared in the page priority over what is declared in width and * height or format options. From 8775d384e1fccf160bc9727d076ffdc23ae53c05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Den=C3=A8le?= Date: Sat, 1 Dec 2018 03:17:17 +0100 Subject: [PATCH 703/799] Extends interfaces for ConnectOptions & LaunchOptions --- types/puppeteer/index.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/types/puppeteer/index.d.ts b/types/puppeteer/index.d.ts index 1b675b20c5..e48e29b7ec 100644 --- a/types/puppeteer/index.d.ts +++ b/types/puppeteer/index.d.ts @@ -1937,7 +1937,7 @@ export interface Target { url(): string; } -export interface LaunchOptions extends Timeoutable { +export interface LaunchOptions extends ChromeArgOptions, BrowserOptions, Timeoutable { /** * Path to a Chromium executable to run instead of bundled Chromium. If * executablePath is a relative path, then it is resolved relative to current @@ -2052,7 +2052,7 @@ export interface BrowserOptions { slowMo?: number; } -export interface ConnectOptions { +export interface ConnectOptions extends BrowserOptions { /** A browser websocket endpoint to connect to. */ browserWSEndpoint?: string; /** @@ -2108,10 +2108,10 @@ export interface CoverageEntry { } /** Attaches Puppeteer to an existing Chromium instance */ -export function connect(options?: ConnectOptions & BrowserOptions): Promise; +export function connect(options?: ConnectOptions): Promise; /** The default flags that Chromium will be launched with */ export function defaultArgs(options?: ChromeArgOptions): string[]; /** Path where Puppeteer expects to find bundled Chromium */ export function executablePath(): string; /** The method launches a browser instance with given arguments. The browser will be closed when the parent node.js process is closed. */ -export function launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions): Promise; +export function launch(options?: LaunchOptions): Promise; From 0c94f13161257397f488f2943b15e3e945cec0a1 Mon Sep 17 00:00:00 2001 From: Levin Keller Date: Thu, 29 Nov 2018 20:21:55 +0100 Subject: [PATCH 704/799] Correctly type callback --- types/web3/providers.d.ts | 10 ++++++---- types/web3/web3-tests.ts | 20 ++++++++++++++++++++ 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/types/web3/providers.d.ts b/types/web3/providers.d.ts index 729ea09278..22a883222f 100644 --- a/types/web3/providers.d.ts +++ b/types/web3/providers.d.ts @@ -12,11 +12,13 @@ interface JsonRPCResponse { error?: string; } +interface Callback { + (error: Error): void; + (error: null, val: ResultType): void; +} + export class Provider { - send( - payload: JsonRPCRequest, - callback: (e: Error, val: JsonRPCResponse) => void - ): any; + send(payload: JsonRPCRequest, callback: Callback): any; } export class WebsocketProvider extends Provider { diff --git a/types/web3/web3-tests.ts b/types/web3/web3-tests.ts index 170a8b22c3..1d7474465e 100644 --- a/types/web3/web3-tests.ts +++ b/types/web3/web3-tests.ts @@ -2,6 +2,7 @@ import Web3 = require("web3"); import BigNumber = require("bn.js"); import { TransactionReceipt } from "web3/types"; import PromiEvent from "web3/promiEvent"; +import { Provider, JsonRPCResponse } from "web3/providers"; const contractAddress = "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe"; @@ -10,6 +11,25 @@ const contractAddress = "0xde0B295669a9FD93d5F28D9Ec85E40f4cb697BAe"; // -------------------------------------------------------------------------- const web3 = new Web3(); const myProvider = new web3.providers.HttpProvider("http://localhost:5454"); + +const createFailingHttpProvider = (): Provider => ({ + send(payload, callback) { + callback(new Error("Illegal!")); + } +}); + +const createSuccesfulHttpProvider = (): Provider => ({ + send(payload, callback) { + const response = {}; + callback(null, response as JsonRPCResponse); + } +}); + +const fakeProvider: Provider = createFailingHttpProvider(); +const otherFakeProvider: Provider = createSuccesfulHttpProvider(); + +web3.setProvider(fakeProvider); +web3.setProvider(otherFakeProvider); web3.setProvider(myProvider); web3.eth.setProvider(myProvider); From c679a8e691db619614c4acb666b768ef2f1508d2 Mon Sep 17 00:00:00 2001 From: Ivo Murrell Date: Sat, 1 Dec 2018 02:32:31 +0000 Subject: [PATCH 705/799] Add type definitions for cfn-response package. --- types/cfn-response/cfn-response-tests.ts | 12 ++++++++++++ types/cfn-response/index.d.ts | 19 +++++++++++++++++++ types/cfn-response/tsconfig.json | 23 +++++++++++++++++++++++ types/cfn-response/tslint.json | 1 + 4 files changed, 55 insertions(+) create mode 100644 types/cfn-response/cfn-response-tests.ts create mode 100644 types/cfn-response/index.d.ts create mode 100644 types/cfn-response/tsconfig.json create mode 100644 types/cfn-response/tslint.json diff --git a/types/cfn-response/cfn-response-tests.ts b/types/cfn-response/cfn-response-tests.ts new file mode 100644 index 0000000000..b9633c17aa --- /dev/null +++ b/types/cfn-response/cfn-response-tests.ts @@ -0,0 +1,12 @@ +import * as cfn from "cfn-response"; +import { CloudFormationCustomResourceEvent, Context } from "aws-lambda"; + +declare const event: CloudFormationCustomResourceEvent; +declare const context: Context; + +// $ExpectType void +cfn.send(event, context, cfn.SUCCESS, { sample: 123 }, "abc"); +// $ExpectType void +cfn.send(event, context, "SUCCESS"); +// $ExpectError +cfn.send(event, context, "", {}); diff --git a/types/cfn-response/index.d.ts b/types/cfn-response/index.d.ts new file mode 100644 index 0000000000..54cb63dfef --- /dev/null +++ b/types/cfn-response/index.d.ts @@ -0,0 +1,19 @@ +// Type definitions for cfn-response 1.0 +// Project: https://github.com/LukeMizuhashi/cfn-response +// Definitions by: Ivo Murrell +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +import { CloudFormationCustomResourceEvent, Context } from "aws-lambda"; + +export type ResponseStatus = "SUCCESS" | "FAILED"; +export const SUCCESS: ResponseStatus; +export const FAILED: ResponseStatus; + +export function send( + event: CloudFormationCustomResourceEvent, + context: Context, + responseStatus: ResponseStatus, + responseData?: object, + physicalResourceId?: string +): void; diff --git a/types/cfn-response/tsconfig.json b/types/cfn-response/tsconfig.json new file mode 100644 index 0000000000..0aff9f9071 --- /dev/null +++ b/types/cfn-response/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "cfn-response-tests.ts" + ] +} diff --git a/types/cfn-response/tslint.json b/types/cfn-response/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/cfn-response/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From c92112c5e79c70f4f4c0b08e4da5077e3e58c916 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 15:09:22 +0100 Subject: [PATCH 706/799] Split sequence declaration --- types/rosie/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/rosie/index.d.ts b/types/rosie/index.d.ts index e66e9855eb..b8c52d3bc0 100644 --- a/types/rosie/index.d.ts +++ b/types/rosie/index.d.ts @@ -163,7 +163,8 @@ declare namespace rosie { * @param {function(number): *=} builder * @return {Factory} */ - sequence(name: keyof T, dependenciesOrBuilder?: (i: number) => any | keyof T[], builder?: Function) : IFactory; + sequence(name: K, builder?: (i: number) => any): IFactory; + sequence(name: keyof T, dependencies: D[], builder: (i: number, ...args: any[]) => any): IFactory; /** * Sets a post-processor callback that will receive built objects and the From 2b8c538ab791543e1c1661dc0700a637f4514bb9 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 15:10:57 +0100 Subject: [PATCH 707/799] Unregistered factories --- types/rosie/index.d.ts | 1 + types/rosie/rosie-tests.ts | 15 +++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/types/rosie/index.d.ts b/types/rosie/index.d.ts index b8c52d3bc0..ad7d8f644d 100644 --- a/types/rosie/index.d.ts +++ b/types/rosie/index.d.ts @@ -8,6 +8,7 @@ declare namespace rosie { interface IFactoryStatic { + new(): IFactory; /** * Defines a factory by name and constructor function. Call #attr and #option * on the result to define the properties of this factory. diff --git a/types/rosie/rosie-tests.ts b/types/rosie/rosie-tests.ts index 86dd049732..bb6b9defb8 100644 --- a/types/rosie/rosie-tests.ts +++ b/types/rosie/rosie-tests.ts @@ -70,6 +70,21 @@ const person = Factory.build('Person'); let aString = ''; aString = person.firstName; +// Unregistered factories +const unregisteredPersonFactory = new Factory(); + +unregisteredPersonFactory.attr('firstName', 'John').sequence('id'); + +// Sequence with dependencies +unregisteredPersonFactory.sequence('lastName', ['age'], (i: number, age: number) => `Doe ${i} ${age}`) + +// Unregistered extended factories + +const unregisteredExtendedPersonFactory = new Factory().extend(unregisteredPersonFactory) + +unregisteredExtendedPersonFactory.attr('firstName', 'John2') +unregisteredExtendedPersonFactory.sequence('lastName', ['age'], (i: number) => `Doe2 ${i}`) + class CustomClass { type: string; From 1bd81e2845069ea2a1696fc367041dec9bb30eb3 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 15:11:19 +0100 Subject: [PATCH 708/799] Add author info --- types/rosie/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/rosie/index.d.ts b/types/rosie/index.d.ts index ad7d8f644d..63624ad3f2 100644 --- a/types/rosie/index.d.ts +++ b/types/rosie/index.d.ts @@ -3,6 +3,7 @@ // Definitions by: Abner Oliveira , // Chris Grigg , // Alex Bukurov +// Adam Misiorny // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 From d2260f4ff382e9128a876325fc22df9b80611443 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Sat, 1 Dec 2018 11:33:29 -0300 Subject: [PATCH 709/799] fix: mdast version --- types/mdast/index.d.ts | 2 +- types/unist/index.d.ts | 4 +--- types/unist/unist-tests.ts | 14 ++++++++------ 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/types/mdast/index.d.ts b/types/mdast/index.d.ts index d7761bd38f..c1fcadec97 100644 --- a/types/mdast/index.d.ts +++ b/types/mdast/index.d.ts @@ -2,7 +2,7 @@ // Project: https://github.com/syntax-tree/mdast // Definitions by: Jun Lu // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.4 +// TypeScript Version: 3.0 import { Parent as UnistParent, Literal as UnistLiteral, Node } from 'unist'; diff --git a/types/unist/index.d.ts b/types/unist/index.d.ts index 55bea58e47..121362a2ac 100644 --- a/types/unist/index.d.ts +++ b/types/unist/index.d.ts @@ -7,8 +7,6 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.0 -export as namespace Unist - // Syntactic units in unist syntax trees are called nodes. export interface Node { // The variant of a node. @@ -59,5 +57,5 @@ export interface Parent extends Node { // Nodes containing a value. export interface Literal extends Node { - value: any; + value: unknown; } diff --git a/types/unist/unist-tests.ts b/types/unist/unist-tests.ts index 9ba2dc06d5..6f10111ba0 100644 --- a/types/unist/unist-tests.ts +++ b/types/unist/unist-tests.ts @@ -1,4 +1,6 @@ -const data: Unist.Data = { +import {Data, Point, Position, Node, Literal, Parent} from './index'; + +const data: Data = { string: 'string', number: 1, object: { @@ -9,32 +11,32 @@ const data: Unist.Data = { null: null }; -const point: Unist.Point = { +const point: Point = { line: 1, column: 1, offset: 0 }; -const position: Unist.Position = { +const position: Position = { start: point, end: point, indent: [1] }; -const node: Unist.Node = { +const node: Node = { type: 'node', data, position }; -const text: Unist.Literal = { +const text: Literal = { type: 'text', data, position, value: 'value' }; -const parent: Unist.Parent = { +const parent: Parent = { type: 'parent', data, position, From 982ed47c5cf0bcea51727e8137b717a536dce726 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Sat, 1 Dec 2018 11:36:35 -0300 Subject: [PATCH 710/799] fix: linting problems --- types/unist/unist-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/unist/unist-tests.ts b/types/unist/unist-tests.ts index 6f10111ba0..1c27db2a58 100644 --- a/types/unist/unist-tests.ts +++ b/types/unist/unist-tests.ts @@ -1,4 +1,4 @@ -import {Data, Point, Position, Node, Literal, Parent} from './index'; +import { Data, Point, Position, Node, Literal, Parent } from 'unist'; const data: Data = { string: 'string', From b3d6ad95f869a0ba8fadc6b6676b6f05c545699f Mon Sep 17 00:00:00 2001 From: Silas Rech Date: Sat, 1 Dec 2018 15:48:04 +0100 Subject: [PATCH 711/799] [hibp] add typings --- types/hibp/hibp-tests.ts | 17 +++++++ types/hibp/index.d.ts | 97 ++++++++++++++++++++++++++++++++++++++++ types/hibp/tsconfig.json | 23 ++++++++++ types/hibp/tslint.json | 1 + 4 files changed, 138 insertions(+) create mode 100644 types/hibp/hibp-tests.ts create mode 100644 types/hibp/index.d.ts create mode 100644 types/hibp/tsconfig.json create mode 100644 types/hibp/tslint.json diff --git a/types/hibp/hibp-tests.ts b/types/hibp/hibp-tests.ts new file mode 100644 index 0000000000..cdcd1851bf --- /dev/null +++ b/types/hibp/hibp-tests.ts @@ -0,0 +1,17 @@ +import * as hibp from 'hibp'; + +hibp +.search('someAccountOrEmail') +.then(data => { + if (data.breaches || data.pastes) { + // Bummer... + console.log(data); + } else { + // Phew! We're clear. + console.log('Good news — no pwnage found!'); + } +}) +.catch(err => { + // Something went wrong. + console.log(err.message); +}); diff --git a/types/hibp/index.d.ts b/types/hibp/index.d.ts new file mode 100644 index 0000000000..27819f1c96 --- /dev/null +++ b/types/hibp/index.d.ts @@ -0,0 +1,97 @@ +// Type definitions for hibp 7.2 +// Project: https://github.com/wkovacs64/hibp +// Definitions by: Silas Rech +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +export interface BreachOptions { + domain?: string; + truncate?: boolean; +} + +export interface Breach { + Name: string; + Title: string; + Domain: string; + BreachDate: string; + AddedDate: string; + ModifiedDate: string; + PwnCount: number; + Description: string; + LogoPath: string; + DataClasses: string[]; + IsVerified: boolean; + IsFabricated: boolean; + IsSensitive: boolean; + IsRetired: boolean; + IsSpamList: boolean; +} + +export interface Paste { + Id: string; + Source: string; + Title: string; + Date: string; + EmailCount: number; +} + +export interface Range { + suffix: string; + count: number; +} + +/** + * Fetches data for a specific breach event. + */ +export function breach(breachName: string): Promise; + +/** + * Fetches breach data for a specific account. + */ +export function breachedAccount(account: string, options?: BreachOptions): Promise; + +/** + * Fetches all breach events in the system. + */ +export function breaches(options?: { domain?: string }): Promise; + +/** + * Fetches all data classes in the system. + */ +export function dataClasses(): Promise; + +/** + * Fetches paste data for a specific email address. + */ +export function pasteAccount(email: string): Promise; + +/** + * Fetches the number of times the the given password has been exposed in a breach (0 indicating no exposure). + * The password is given in plain text, but only the first 5 characters of its SHA-1 hash will be submitted to the API. + */ +export function pwnedPassword(password: string): Promise; + +/** + * Fetches the SHA-1 hash suffixes for the given 5-character SHA-1 hash prefix. + * + * When a password hash with the same first 5 characters is found in the Pwned Passwords repository, + * the API will respond with an HTTP 200 and include the suffix of every hash beginning with the specified prefix, + * followed by a count of how many times it appears in the data set. + * + * This function parses the response and returns a more structured format. + */ +export function pwnedPasswordRange(prefix: string): Promise; + +/** + * Fetches all breaches and all pastes associated with the provided account (email address or username). + * + * Note that the remote API does not support querying pastes by username (only email addresses), + * so in the event the provided account is not a valid email address, + * only breach data is queried and the "pastes" field of the resulting object will always be null. + * + * This is exactly how searching via the current web interface behaves, which this convenience method is designed to mimic. + * + */ +export function search(account: string, options?: BreachOptions): Promise<{ breaches?: Breach[], pastes?: Paste[] }>; diff --git a/types/hibp/tsconfig.json b/types/hibp/tsconfig.json new file mode 100644 index 0000000000..58ecb92a11 --- /dev/null +++ b/types/hibp/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "hibp-tests.ts" + ] +} diff --git a/types/hibp/tslint.json b/types/hibp/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/hibp/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 8b0dd4b73160fd8d77cc9dcd7e227159588c5552 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Sat, 1 Dec 2018 11:54:46 -0300 Subject: [PATCH 712/799] fix: remove mandatory indent property --- types/unist/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/unist/index.d.ts b/types/unist/index.d.ts index 121362a2ac..202b315250 100644 --- a/types/unist/index.d.ts +++ b/types/unist/index.d.ts @@ -34,7 +34,7 @@ export interface Position { // Start column at each index (plus start line) in the source region, // for elements that span multiple lines. - indent: number[]; + indent?: number[]; } // One place in a source file. From 0084184b14ff5aaeb264188421e51f5af205e779 Mon Sep 17 00:00:00 2001 From: Hernan Rajchert Date: Sat, 1 Dec 2018 11:58:20 -0300 Subject: [PATCH 713/799] refactor: converted comments in multi-line to see them in the IDE --- types/unist/index.d.ts | 70 +++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 18 deletions(-) diff --git a/types/unist/index.d.ts b/types/unist/index.d.ts index 202b315250..023b1c11e3 100644 --- a/types/unist/index.d.ts +++ b/types/unist/index.d.ts @@ -7,55 +7,89 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.0 -// Syntactic units in unist syntax trees are called nodes. +/** + * Syntactic units in unist syntax trees are called nodes. + */ export interface Node { - // The variant of a node. + /** + * The variant of a node. + */ type: string; - // Information from the ecosystem. + /** + * Information from the ecosystem. + */ data?: Data; - // Location of a node in a source document. - // Must not be present if a node is generated. + /** + * Location of a node in a source document. + * Must not be present if a node is generated. + */ position?: Position; } +/** + * Information associated by the ecosystem with the node. + * Space is guaranteed to never be specified by unist or specifications + * implementing unist. + */ export interface Data { [key: string]: unknown; } -// Location of a node in a source file. +/** + * Location of a node in a source file. + */ export interface Position { - // Place of the first character of the parsed source region. + /** + * Place of the first character of the parsed source region. + */ start: Point; - // Place of the first character after the parsed source region. + /** + * Place of the first character after the parsed source region. + */ end: Point; - // Start column at each index (plus start line) in the source region, - // for elements that span multiple lines. + /** + * Start column at each index (plus start line) in the source region, + * for elements that span multiple lines. + */ indent?: number[]; } -// One place in a source file. +/** + * One place in a source file. + */ export interface Point { - // Line in a source file (1-indexed integer). + /** + * Line in a source file (1-indexed integer). + */ line: number; - // Column in a source file (1-indexed integer). + /** + * Column in a source file (1-indexed integer). + */ column: number; - - // Character in a source file (0-indexed integer). + /** + * Character in a source file (0-indexed integer). + */ offset?: number; } -// Nodes containing other nodes. +/** + * Nodes containing other nodes. + */ export interface Parent extends Node { - // List representing the children of a node. + /** + * List representing the children of a node. + */ children: Node[]; } -// Nodes containing a value. +/** + * Nodes containing a value. + */ export interface Literal extends Node { value: unknown; } From 2c5d06c3e8368dabfbb5e2a6f6958148857fe0d6 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 16:01:05 +0100 Subject: [PATCH 714/799] [@storybook/addon-options] Add withOptions --- types/storybook__addon-options/index.d.ts | 7 +++++++ .../storybook__addon-options-tests.ts | 19 ++++++++++++++++++- types/storybook__addon-options/tsconfig.json | 5 ++++- 3 files changed, 29 insertions(+), 2 deletions(-) diff --git a/types/storybook__addon-options/index.d.ts b/types/storybook__addon-options/index.d.ts index 61f9f11def..a0baa39ab2 100644 --- a/types/storybook__addon-options/index.d.ts +++ b/types/storybook__addon-options/index.d.ts @@ -6,6 +6,8 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 +import { StoryDecorator } from "@storybook/react"; + export interface Options { name?: string; url?: string; @@ -23,4 +25,9 @@ export interface Options { selectedAddonPanel?: string; } +/** + * @deprecated Use withOptions instead + */ export function setOptions(options: Options): void; + +export function withOptions(options: Options): StoryDecorator; diff --git a/types/storybook__addon-options/storybook__addon-options-tests.ts b/types/storybook__addon-options/storybook__addon-options-tests.ts index a3003c913f..1fc49d18e0 100644 --- a/types/storybook__addon-options/storybook__addon-options-tests.ts +++ b/types/storybook__addon-options/storybook__addon-options-tests.ts @@ -1,4 +1,5 @@ -import { setOptions } from '@storybook/addon-options'; +import { setOptions, withOptions } from '@storybook/addon-options'; +import { addDecorator } from '@storybook/react'; setOptions({ name: 'My Storybook', @@ -31,3 +32,19 @@ setOptions({ hierarchySeparator: '.', hierarchyRootSeparator: '#', }); + +addDecorator( + withOptions({ + name: "My Storybook", + url: "https://example.com", + goFullScreen: false, + showStoriesPanel: false, + showAddonPanel: false, + showSearchBox: false, + addonPanelInRight: false, + sortStoriesByKind: false, + hierarchySeparator: /\//, + hierarchyRootSeparator: /\|/, + selectedAddonPanel: "storybook/actions/action-panel" + }) +); diff --git a/types/storybook__addon-options/tsconfig.json b/types/storybook__addon-options/tsconfig.json index 936a535725..df1a88f769 100644 --- a/types/storybook__addon-options/tsconfig.json +++ b/types/storybook__addon-options/tsconfig.json @@ -15,6 +15,9 @@ "paths": { "@storybook/addon-options": [ "storybook__addon-options" + ], + "@storybook/react": [ + "storybook__react" ] }, "types": [], @@ -25,4 +28,4 @@ "index.d.ts", "storybook__addon-options-tests.ts" ] -} \ No newline at end of file +} From 6e11b5df9d359a15d2851144b130139259f36ae4 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 16:02:18 +0100 Subject: [PATCH 715/799] Add author --- types/storybook__addon-options/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/storybook__addon-options/index.d.ts b/types/storybook__addon-options/index.d.ts index a0baa39ab2..42010b84e4 100644 --- a/types/storybook__addon-options/index.d.ts +++ b/types/storybook__addon-options/index.d.ts @@ -3,6 +3,7 @@ // Definitions by: Joscha Feth // Simon Helle Nielsen // A.MacLeay +// Adam Misiorny // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 From e66e6ed61f4b7ebe84b84ad46c6cc7f982b0bf72 Mon Sep 17 00:00:00 2001 From: Adam Misiorny Date: Sat, 1 Dec 2018 16:13:44 +0100 Subject: [PATCH 716/799] Increase typescript version to match @storybook/react --- types/storybook__addon-options/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/storybook__addon-options/index.d.ts b/types/storybook__addon-options/index.d.ts index 42010b84e4..ec3ba1e252 100644 --- a/types/storybook__addon-options/index.d.ts +++ b/types/storybook__addon-options/index.d.ts @@ -5,7 +5,7 @@ // A.MacLeay // Adam Misiorny // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.3 +// TypeScript Version: 2.8 import { StoryDecorator } from "@storybook/react"; From 21179bbf4603a1a25762715eb1b4a22fccc867a2 Mon Sep 17 00:00:00 2001 From: Silas Rech Date: Sat, 1 Dec 2018 16:31:01 +0100 Subject: [PATCH 717/799] [cson-parser] add typings --- types/cson-parser/cson-parser-tests.ts | 5 +++++ types/cson-parser/index.d.ts | 25 +++++++++++++++++++++++++ types/cson-parser/tsconfig.json | 23 +++++++++++++++++++++++ types/cson-parser/tslint.json | 1 + 4 files changed, 54 insertions(+) create mode 100644 types/cson-parser/cson-parser-tests.ts create mode 100644 types/cson-parser/index.d.ts create mode 100644 types/cson-parser/tsconfig.json create mode 100644 types/cson-parser/tslint.json diff --git a/types/cson-parser/cson-parser-tests.ts b/types/cson-parser/cson-parser-tests.ts new file mode 100644 index 0000000000..955aadcffe --- /dev/null +++ b/types/cson-parser/cson-parser-tests.ts @@ -0,0 +1,5 @@ +import * as CSON from 'cson-parser'; + +CSON.parse('[ 1, 2, a: "str" ]'); + +CSON.stringify({ domain: 'typescript.org' }, null, 4); diff --git a/types/cson-parser/index.d.ts b/types/cson-parser/index.d.ts new file mode 100644 index 0000000000..b8e1db7421 --- /dev/null +++ b/types/cson-parser/index.d.ts @@ -0,0 +1,25 @@ +// Type definitions for cson-parser 4.0 +// Project: https://github.com/groupon/cson-parser +// Definitions by: Silas Rech +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +export type ReplacerFunction = (key: string, value: any) => any; + +/** + * Converts a CSON string into an object. + * @param text A valid CSON string. + * @param reviver A function that transforms the results. This function is called for each member of the object. + * If a member contains nested objects, the nested objects are transformed before the parent object is. + */ +export function parse(text: string, reviver?: (key: any, value: any) => any): any; + +/** + * Converts a JavaScript value to a CSON string. + * @param value A JavaScript value, usually an object or array, to be converted. + * @param replacer A function that transforms the results or an array of strings and numbers that acts as a approved list for selecting the object properties that will be stringified. + * @param space Adds indentation, white space, and line break characters to the return-value CSON text to make it easier to read. + */ +export function stringify(value: any, replacer?: ReplacerFunction | Array<(number | string)> | null, space?: string | number): string; diff --git a/types/cson-parser/tsconfig.json b/types/cson-parser/tsconfig.json new file mode 100644 index 0000000000..374ff4913f --- /dev/null +++ b/types/cson-parser/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "cson-parser-tests.ts" + ] +} diff --git a/types/cson-parser/tslint.json b/types/cson-parser/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/cson-parser/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From ba67cbd87032a56e0c10378d989da955a0b902aa Mon Sep 17 00:00:00 2001 From: Silas Rech Date: Sat, 1 Dec 2018 17:52:49 +0100 Subject: [PATCH 718/799] [sass] add typings --- types/sass/index.d.ts | 203 +++++++++++++++++++++++++++++++++++++++ types/sass/sass-tests.ts | 7 ++ types/sass/tsconfig.json | 23 +++++ types/sass/tslint.json | 1 + 4 files changed, 234 insertions(+) create mode 100644 types/sass/index.d.ts create mode 100644 types/sass/sass-tests.ts create mode 100644 types/sass/tsconfig.json create mode 100644 types/sass/tslint.json diff --git a/types/sass/index.d.ts b/types/sass/index.d.ts new file mode 100644 index 0000000000..0131836143 --- /dev/null +++ b/types/sass/index.d.ts @@ -0,0 +1,203 @@ +// Type definitions for sass 1.15 +// Project: https://github.com/sass/dart-sass +// Definitions by: Silas Rech +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +export type ImporterReturnType = { file: string } | { contents: string } | Error | null; + +export type Importer = (url: string, prev: string, done: (data: ImporterReturnType) => void) => ImporterReturnType | void; + +export interface Options { + /** + * Path to a file to compile. + * + * @default null + */ + file?: string; + + /** + * A string to pass to compile. + * + * It is recommended that you use `includePaths` in conjunction with this so that sass can find files when using the @import directive. + * + * @default null + */ + data?: string; + + /** + * Handles when the @import directive is encountered. + * + * A custom importer allows extension of the sass engine in both a synchronous and asynchronous manner. + * + * @default undefined + */ + importer?: Importer | Importer[]; + + /** + * Holds a collection of custom functions that may be invoked by the sass files being compiled. + * + * @default undefined + */ + functions?: { [key: string]: () => void }; + + /** + * An array of paths that should be looked in to attempt to resolve your @import declarations. + * When using `data`, it is recommended that you use this. + * + * @default [] + */ + includePaths?: string[]; + + /** + * Enable Sass Indented Syntax for parsing the data string or file. + * + * @default false + */ + indentedSyntax?: boolean; + + /** + * Used to determine whether to use space or tab character for indentation. + * + * @default 'space' + */ + indentType?: 'space' | 'tab'; + + /** + * Used to determine the number of spaces or tabs to be used for indentation. + * + * @default 2 + */ + indentWidth?: number; + + /** + * Used to determine which sequence to use for line breaks. + * + * @default 'lf' + */ + linefeed?: 'cr' | 'crlf' | 'lf' | 'lfcr'; + + /** + * Disable the inclusion of source map information in the output file. + * + * @default false + */ + omitSourceMapUrl?: boolean; + + /** + * Specify the intended location of the output file. + * Strongly recommended when outputting source maps so that they can properly refer back to their intended files. + * + * @default null + */ + outFile?: string; + + /** + * Determines the output format of the final CSS style. + * + * @default 'expanded' + */ + outputStyle?: 'compressed' | 'expanded'; + + /** + * Enables the outputting of a source map. + * + * @default undefined + */ + sourceMap?: boolean | string; + + /** + * Includes the contents in the source map information. + * + * @default false + */ + sourceMapContents?: boolean; + + /** + * Embeds the source map as a data URI. + * + * @default false + */ + sourceMapEmbed?: boolean; + + /** + * The value will be emitted as `sourceRoot` in the source map information. + * + * @default undefined + */ + sourceMapRoot?: string; +} + +export interface SassException extends Error { + /** + * The error message. + */ + message: string; + + /** + * The line number of error. + */ + line: number; + + /** + * The column number of error. + */ + column: number; + + /** + * The status code. + */ + status: number; + + /** + * The filename of error. + * + * In case file option was not set (in favour of `data`), this will reflect the value `stdin`. + */ + file: string; +} + +export interface Result { + /** + * The compiled CSS. + * + * Write this to a file, or serve it out as needed. + */ + css: Buffer; + + /** + * The source map. + */ + map?: Buffer; + stats: { + /** + * The path to the scss file, or `data` if the source was not a file. + */ + entry: string; + + /** + * `Date.now()` before the compilation. + */ + start: number; + + /** + * `Date.now()` after the compilation. + */ + end: number; + + /** + * `end - start` + */ + duration: number; + + /** + * Absolute paths to all related files in no particular order. + */ + includedFiles: string[]; + }; +} + +export function render(options: Options, callback: (exception: SassException, result: Result) => void): void; +export function renderSync(options: Options): Result; diff --git a/types/sass/sass-tests.ts b/types/sass/sass-tests.ts new file mode 100644 index 0000000000..ae656d0a98 --- /dev/null +++ b/types/sass/sass-tests.ts @@ -0,0 +1,7 @@ +import * as sass from 'sass'; + +sass.renderSync({ + file: 'index.scss', + sourceMap: true, + outFile: 'index.css', +}); diff --git a/types/sass/tsconfig.json b/types/sass/tsconfig.json new file mode 100644 index 0000000000..11599da1da --- /dev/null +++ b/types/sass/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "sass-tests.ts" + ] +} diff --git a/types/sass/tslint.json b/types/sass/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/sass/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From ff503e74dd923e53cf48c6989eda5cc6a3b543d0 Mon Sep 17 00:00:00 2001 From: Ivan Fernandes Date: Sun, 2 Dec 2018 01:38:59 -0200 Subject: [PATCH 719/799] passport-bnet type definitions --- types/passport-bnet/index.d.ts | 42 ++++++++++++++ types/passport-bnet/passport-bnet-tests.ts | 65 ++++++++++++++++++++++ types/passport-bnet/tsconfig.json | 23 ++++++++ types/passport-bnet/tslint.json | 1 + 4 files changed, 131 insertions(+) create mode 100644 types/passport-bnet/index.d.ts create mode 100644 types/passport-bnet/passport-bnet-tests.ts create mode 100644 types/passport-bnet/tsconfig.json create mode 100644 types/passport-bnet/tslint.json diff --git a/types/passport-bnet/index.d.ts b/types/passport-bnet/index.d.ts new file mode 100644 index 0000000000..ef6f977830 --- /dev/null +++ b/types/passport-bnet/index.d.ts @@ -0,0 +1,42 @@ +// Type definitions for passport-bnet 2.0.0 +// Project: https://github.com/Blizzard/passport-bnet#readme +// Definitions by: Ivan Fernandes +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import { Strategy as OAuth2Strategy, VerifyFunction, VerifyFunctionWithRequest } from 'passport-oauth2'; + +declare class BnetStrategy extends OAuth2Strategy { + constructor(options: BnetStrategy.StrategyOptions, verify: VerifyFunction); + constructor(options: BnetStrategy.StrategyOptionsWithRequest, verify: VerifyFunctionWithRequest); +} + +declare namespace BnetStrategy { + + interface _BaseBnetOptions { + region?: string; + + scopeSeparator?: string; + customHeaders?: object; + authorizationURL?: string; + tokenURL?: string; + scope?: string; + clientID: string; + clientSecret: string; + callbackURL?: string; + } + + interface StrategyOptions extends _BaseBnetOptions { + passReqToCallback?: false; + } + + interface StrategyOptionsWithRequest extends _BaseBnetOptions { + passReqToCallback: true; + } + + function getHost(region: string): string; + + type Strategy = BnetStrategy; + const Strategy: typeof BnetStrategy; +} + +export = BnetStrategy \ No newline at end of file diff --git a/types/passport-bnet/passport-bnet-tests.ts b/types/passport-bnet/passport-bnet-tests.ts new file mode 100644 index 0000000000..86f3090c88 --- /dev/null +++ b/types/passport-bnet/passport-bnet-tests.ts @@ -0,0 +1,65 @@ +//Based on passport-oauth2/passport-oauth2-tests.ts + +import BnetStrategy = require("passport-bnet"); +import { Strategy, StrategyOptions, StrategyOptionsWithRequest } from "passport-bnet"; +import { Strategy as OAuth2Strategy } from "passport-oauth2"; +import { VerifyCallback } from "passport-oauth2"; +import { Request } from "express"; + +const strategyOptions1: StrategyOptions = { + authorizationURL: 'http://www.example.com/auth', + callbackURL: 'http://www.example.com/callback', + clientID: 'dummy', + clientSecret: 'secret', + tokenURL: 'http://www.example.com/token', + region: 'us', + scope: "email", + scopeSeparator: ' ', + customHeaders: {} +} + +function verifyFunction1(_accessToken: string, _refreshToken: string, _profile: any, verifyCallback: VerifyCallback) { + verifyCallback(new Error('unimplemented')); +} + +function verifyFunction2(_accessToken: string, _refreshToken: string, _results: any, _profile: any, verifyCallback: VerifyCallback) { + verifyCallback(new Error('unimplemented')); +} + +const strategy1: BnetStrategy = new BnetStrategy(strategyOptions1, verifyFunction1); + +const strategy2: Strategy = new BnetStrategy(strategyOptions1, verifyFunction2); + +function verifyFunction3(_req: Request, _accessToken: string, _refreshToken: string, _profile: any, verifyCallback: VerifyCallback) { + verifyCallback(undefined, { userid: '1' }); +} + +function verifyFunction4(_req: Request, _accessToken: string, _refreshToken: string, _results: any, _profile: any, verifyCallback: VerifyCallback) { + verifyCallback(undefined, { userid: '1' }); +} + +const strategyOptions2: StrategyOptionsWithRequest = { + authorizationURL: 'http://www.example.com/auth', + callbackURL: 'http://www.example.com/callback', + clientID: 'dummy', + clientSecret: 'secret', + tokenURL: 'http://www.example.com/token', + region: 'us', + scope: "email", + scopeSeparator: ' ', + customHeaders: {}, + passReqToCallback: true +}; + +const strategy3: OAuth2Strategy = new BnetStrategy +(strategyOptions2, verifyFunction3); + +const strategy4: Strategy = new Strategy(strategyOptions2, verifyFunction4); + +class MyStrategy extends BnetStrategy { + useProtectedProperty() { + this._oauth2.get('http://www.example.com/profile', 'token', err => err.statusCode); + this._oauth2.get('http://www.example.com/profile', 'token', (err, result) => result); + this._oauth2.get('http://www.example.com/profile', 'token', (err, result, response) => response); + } +} \ No newline at end of file diff --git a/types/passport-bnet/tsconfig.json b/types/passport-bnet/tsconfig.json new file mode 100644 index 0000000000..28da7a7a65 --- /dev/null +++ b/types/passport-bnet/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "passport-bnet-tests.ts" + ] +} \ No newline at end of file diff --git a/types/passport-bnet/tslint.json b/types/passport-bnet/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/passport-bnet/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 374b24ef8732e7907faef7bb13b4326191d1747d Mon Sep 17 00:00:00 2001 From: Ivan Fernandes Date: Sun, 2 Dec 2018 02:03:00 -0200 Subject: [PATCH 720/799] adding typescript version --- types/passport-bnet/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/passport-bnet/index.d.ts b/types/passport-bnet/index.d.ts index ef6f977830..1b28ee21ad 100644 --- a/types/passport-bnet/index.d.ts +++ b/types/passport-bnet/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/Blizzard/passport-bnet#readme // Definitions by: Ivan Fernandes // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 import { Strategy as OAuth2Strategy, VerifyFunction, VerifyFunctionWithRequest } from 'passport-oauth2'; From 55dc8ebd80d0386841468e2c515aba766fba5da3 Mon Sep 17 00:00:00 2001 From: Ivan Fernandes Date: Sun, 2 Dec 2018 02:10:27 -0200 Subject: [PATCH 721/799] fomatting --- types/passport-bnet/index.d.ts | 7 +++---- types/passport-bnet/passport-bnet-tests.ts | 9 ++++----- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/types/passport-bnet/index.d.ts b/types/passport-bnet/index.d.ts index 1b28ee21ad..e5493a8d3c 100644 --- a/types/passport-bnet/index.d.ts +++ b/types/passport-bnet/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for passport-bnet 2.0.0 +// Type definitions for passport-bnet 2.0. // Project: https://github.com/Blizzard/passport-bnet#readme // Definitions by: Ivan Fernandes // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -12,7 +12,6 @@ declare class BnetStrategy extends OAuth2Strategy { } declare namespace BnetStrategy { - interface _BaseBnetOptions { region?: string; @@ -20,7 +19,7 @@ declare namespace BnetStrategy { customHeaders?: object; authorizationURL?: string; tokenURL?: string; - scope?: string; + scope?: string; clientID: string; clientSecret: string; callbackURL?: string; @@ -40,4 +39,4 @@ declare namespace BnetStrategy { const Strategy: typeof BnetStrategy; } -export = BnetStrategy \ No newline at end of file +export = BnetStrategy; diff --git a/types/passport-bnet/passport-bnet-tests.ts b/types/passport-bnet/passport-bnet-tests.ts index 86f3090c88..06c0ffccec 100644 --- a/types/passport-bnet/passport-bnet-tests.ts +++ b/types/passport-bnet/passport-bnet-tests.ts @@ -1,9 +1,8 @@ -//Based on passport-oauth2/passport-oauth2-tests.ts +// Based on passport-oauth2/passport-oauth2-tests.ts import BnetStrategy = require("passport-bnet"); import { Strategy, StrategyOptions, StrategyOptionsWithRequest } from "passport-bnet"; -import { Strategy as OAuth2Strategy } from "passport-oauth2"; -import { VerifyCallback } from "passport-oauth2"; +import { Strategy as OAuth2Strategy, VerifyCallback } from "passport-oauth2"; import { Request } from "express"; const strategyOptions1: StrategyOptions = { @@ -16,7 +15,7 @@ const strategyOptions1: StrategyOptions = { scope: "email", scopeSeparator: ' ', customHeaders: {} -} +}; function verifyFunction1(_accessToken: string, _refreshToken: string, _profile: any, verifyCallback: VerifyCallback) { verifyCallback(new Error('unimplemented')); @@ -62,4 +61,4 @@ class MyStrategy extends BnetStrategy { this._oauth2.get('http://www.example.com/profile', 'token', (err, result) => result); this._oauth2.get('http://www.example.com/profile', 'token', (err, result, response) => response); } -} \ No newline at end of file +} From 47fa3e69a48443e99093497e234cd5fb4159761d Mon Sep 17 00:00:00 2001 From: Ivan Fernandes Date: Sun, 2 Dec 2018 02:12:46 -0200 Subject: [PATCH 722/799] fixing version notation --- types/passport-bnet/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/passport-bnet/index.d.ts b/types/passport-bnet/index.d.ts index e5493a8d3c..86255c782d 100644 --- a/types/passport-bnet/index.d.ts +++ b/types/passport-bnet/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for passport-bnet 2.0. +// Type definitions for passport-bnet 2.0 // Project: https://github.com/Blizzard/passport-bnet#readme // Definitions by: Ivan Fernandes // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From c45cef2c6ebdbb8764f2631154f61213109c5733 Mon Sep 17 00:00:00 2001 From: Kobi Cohen Date: Sun, 2 Dec 2018 12:58:30 +0200 Subject: [PATCH 723/799] updating isMatchWithCustomizer type to accept two more arguments: object and source per lodash docs https://lodash.com/docs/4.17.11#isMatchWith --- types/lodash/common/lang.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/lodash/common/lang.d.ts b/types/lodash/common/lang.d.ts index 9afe554b28..723388c9cc 100644 --- a/types/lodash/common/lang.d.ts +++ b/types/lodash/common/lang.d.ts @@ -1020,7 +1020,7 @@ declare module "../index" { // isMatchWith - type isMatchWithCustomizer = (value: any, other: any, indexOrKey: PropertyName) => boolean; + type isMatchWithCustomizer = (value: any, other: any, indexOrKey: PropertyName, object: object, source: object) => boolean; interface LoDashStatic { /** From df0bcd09d20e3b763664f4d4ca249ce0b22687c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20D=C3=BCfel?= Date: Sun, 2 Dec 2018 17:13:01 +0100 Subject: [PATCH 724/799] Replace Bluebird by native Promises --- types/bull/index.d.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/types/bull/index.d.ts b/types/bull/index.d.ts index c08048f1d7..2d18e0a800 100644 --- a/types/bull/index.d.ts +++ b/types/bull/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for bull 3.4 +// Type definitions for bull 3.5 // Project: https://github.com/OptimalBits/bull // Definitions by: Bruno Grieder // Cameron Crothers @@ -17,7 +17,6 @@ // TypeScript Version: 2.8 import * as Redis from "ioredis"; -import * as Promise from "bluebird"; /** * This is the Queue constructor. From 788d99040f5ae9e75dbf8649b4856eaf18d07ea3 Mon Sep 17 00:00:00 2001 From: Robin Hames Date: Sun, 2 Dec 2018 18:50:31 +0000 Subject: [PATCH 725/799] Add configPath to ConfigStoreOptions in @types/configstore --- types/configstore/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/configstore/index.d.ts b/types/configstore/index.d.ts index 2617f2bce0..bbc0740c23 100644 --- a/types/configstore/index.d.ts +++ b/types/configstore/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for configstore 2.1 +// Type definitions for configstore 4.0 // Project: https://github.com/yeoman/configstore // Definitions by: ArcticLight // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -67,5 +67,6 @@ declare class Configstore { declare namespace Configstore { interface ConfigstoreOptions { globalConfigPath?: boolean; + configPath?: string; } } From 4e8911977001fbfef99652853e182ef604d8b86a Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Sun, 2 Dec 2018 19:38:23 +0100 Subject: [PATCH 726/799] Add types for fuzzy-search --- types/fuzzy-search/fuzzy-search-tests.ts | 27 ++++++++++++++++++++++++ types/fuzzy-search/index.d.ts | 26 +++++++++++++++++++++++ types/fuzzy-search/tsconfig.json | 23 ++++++++++++++++++++ types/fuzzy-search/tslint.json | 1 + 4 files changed, 77 insertions(+) create mode 100644 types/fuzzy-search/fuzzy-search-tests.ts create mode 100644 types/fuzzy-search/index.d.ts create mode 100644 types/fuzzy-search/tsconfig.json create mode 100644 types/fuzzy-search/tslint.json diff --git a/types/fuzzy-search/fuzzy-search-tests.ts b/types/fuzzy-search/fuzzy-search-tests.ts new file mode 100644 index 0000000000..667cda446f --- /dev/null +++ b/types/fuzzy-search/fuzzy-search-tests.ts @@ -0,0 +1,27 @@ +import FuzzySearch = require('fuzzy-search'); + +const f = new FuzzySearch(['1', '2', '3']); + +new FuzzySearch([{ a: 1 }, { a: 2 }, { a: 3 }], ['a']); + +new FuzzySearch([{ a: 1 }, { a: 2 }, { a: 3 }], ['a'], {}); + +new FuzzySearch([{ a: 1 }, { a: 2 }, { a: 3 }], ['a'], { caseSensitive: true }); + +new FuzzySearch([{ a: 1 }, { a: 2 }, { a: 3 }], ['a'], { sort: true }); + +new FuzzySearch([{ a: 1 }, { a: 2 }, { a: 3 }], ['a'], { caseSensitive: true, sort: true }); + +let strArr: string[]; + +strArr = f.haystack; +// $ExpectType string[] +f.keys; +// $ExpectType Required +f.options; + +strArr = new FuzzySearch(['1', '2', '3']).search(); +strArr = new FuzzySearch(['1', '2', '3']).search('2'); + +// $ExpectType number +FuzzySearch.isMatch('1', '1', false); diff --git a/types/fuzzy-search/index.d.ts b/types/fuzzy-search/index.d.ts new file mode 100644 index 0000000000..8c3d5103ff --- /dev/null +++ b/types/fuzzy-search/index.d.ts @@ -0,0 +1,26 @@ +// Type definitions for fuzzy-search 2.1 +// Project: https://github.com/wouter2203/fuzzy-search#readme +// Definitions by: Alex Deas +// BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +declare class FuzzySearch { + haystack: T[]; + keys: string[]; + options: Required; + + static isMatch(item: string, query: string, caseSensitive: boolean): number; + + constructor(haystack: T[], keys?: string[], options?: FuzzySearch.Options); + search(needle?: string): T[]; +} + +declare namespace FuzzySearch { + interface Options { + caseSensitive?: boolean; + sort?: boolean; + } +} + +export = FuzzySearch; diff --git a/types/fuzzy-search/tsconfig.json b/types/fuzzy-search/tsconfig.json new file mode 100644 index 0000000000..c72f9609d0 --- /dev/null +++ b/types/fuzzy-search/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "fuzzy-search-tests.ts" + ] +} diff --git a/types/fuzzy-search/tslint.json b/types/fuzzy-search/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/fuzzy-search/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 1aeeff704cbf6b3ab599b4b6ff232690771b2099 Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Sun, 2 Dec 2018 20:21:13 +0100 Subject: [PATCH 727/799] Add types for snakecase-keys --- types/snakecase-keys/index.d.ts | 19 ++++++++++++++++ types/snakecase-keys/snakecase-keys-tests.ts | 5 +++++ types/snakecase-keys/tsconfig.json | 23 ++++++++++++++++++++ types/snakecase-keys/tslint.json | 1 + 4 files changed, 48 insertions(+) create mode 100644 types/snakecase-keys/index.d.ts create mode 100644 types/snakecase-keys/snakecase-keys-tests.ts create mode 100644 types/snakecase-keys/tsconfig.json create mode 100644 types/snakecase-keys/tslint.json diff --git a/types/snakecase-keys/index.d.ts b/types/snakecase-keys/index.d.ts new file mode 100644 index 0000000000..d9afe0a2fd --- /dev/null +++ b/types/snakecase-keys/index.d.ts @@ -0,0 +1,19 @@ +// Type definitions for snakecase-keys 2.1 +// Project: https://github.com/bendrucker/snakecase-keys#readme +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +export = snakecaseKeys; + +declare function snakecaseKeys( + obj: object, + options?: snakecaseKeys.Options +): { [key: string]: any }; + +declare namespace snakecaseKeys { + interface Options { + deep?: boolean; + exclude?: Array; + } +} diff --git a/types/snakecase-keys/snakecase-keys-tests.ts b/types/snakecase-keys/snakecase-keys-tests.ts new file mode 100644 index 0000000000..e74d13404f --- /dev/null +++ b/types/snakecase-keys/snakecase-keys-tests.ts @@ -0,0 +1,5 @@ +import snakecaseKeys = require('snakecase-keys'); + +snakecaseKeys({ fooBar: 'baz' }); +snakecaseKeys({ fooBar: 'baz' }, { deep: false }); +snakecaseKeys({ fooBar: 'baz' }, { exclude: ['fooBax', /Foo$/] }); diff --git a/types/snakecase-keys/tsconfig.json b/types/snakecase-keys/tsconfig.json new file mode 100644 index 0000000000..6d944fa502 --- /dev/null +++ b/types/snakecase-keys/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "snakecase-keys-tests.ts" + ] +} diff --git a/types/snakecase-keys/tslint.json b/types/snakecase-keys/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/snakecase-keys/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From ec7a15613f2ccdb7e63d0ffc1d154bfa93395355 Mon Sep 17 00:00:00 2001 From: Robin Hames Date: Sun, 2 Dec 2018 19:21:34 +0000 Subject: [PATCH 728/799] Add test for ConfigStoreOptions.configPath in @types/configstore --- types/configstore/configstore-tests.ts | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/types/configstore/configstore-tests.ts b/types/configstore/configstore-tests.ts index ffd04e31a7..9365afdbda 100644 --- a/types/configstore/configstore-tests.ts +++ b/types/configstore/configstore-tests.ts @@ -5,6 +5,7 @@ let value: any; let key: string; let num: number; let object: any; +let path: string; cs.set(key, value); value = cs.get(key); @@ -13,4 +14,12 @@ cs.delete(key); object = cs.all; cs.all = object; num = cs.size; -key = cs.path; +path = cs.path; + +const csWithPathOption = new Configstore('foo', null, { configPath: path }); + +csWithPathOption.set(key, value); +value = csWithPathOption.get(key); +csWithPathOption.delete(key); + +key = csWithPathOption.path; From 1bb213f443c6dc0eff1792967feb08b0aa59e555 Mon Sep 17 00:00:00 2001 From: Jacob Greenfield Date: Sun, 2 Dec 2018 14:50:04 -0500 Subject: [PATCH 729/799] Make argument to getFormatter optional See here: https://eslint.org/docs/developer-guide/nodejs-api#clienginegetformatter --- types/eslint/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/eslint/index.d.ts b/types/eslint/index.d.ts index 451477af40..01f39ee83e 100644 --- a/types/eslint/index.d.ts +++ b/types/eslint/index.d.ts @@ -471,7 +471,7 @@ export class CLIEngine { isPathIgnored(filePath: string): boolean; - getFormatter(format: string): CLIEngine.Formatter; + getFormatter(format?: string): CLIEngine.Formatter; getRules(): Map; From 9f24a56a9c1cd62aae856f0c1154b4ea99e04d1a Mon Sep 17 00:00:00 2001 From: Jacob Greenfield Date: Sun, 2 Dec 2018 15:02:01 -0500 Subject: [PATCH 730/799] Update tests --- types/eslint/eslint-tests.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/types/eslint/eslint-tests.ts b/types/eslint/eslint-tests.ts index c6b8b786fa..ed211d220e 100644 --- a/types/eslint/eslint-tests.ts +++ b/types/eslint/eslint-tests.ts @@ -480,7 +480,10 @@ cli.addPlugin('my-fancy-plugin', {}); cli.isPathIgnored('./dist/index.js'); -const formatter = cli.getFormatter('codeframe'); +let formatter: CLIEngine.Formatter; + +formatter = cli.getFormatter('codeframe'); +formatter = cli.getFormatter(); formatter(cliReport.results); From 0dc2aeee2feacafe39f0a73dc07fd2cd090e9a32 Mon Sep 17 00:00:00 2001 From: Jannik Keye Date: Sun, 2 Dec 2018 22:02:51 +0100 Subject: [PATCH 731/799] fxi: fastify version support 2.0 release candidate --- types/fastify-jwt/fastify-jwt-tests.ts | 7 +++---- types/fastify-jwt/package.json | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/types/fastify-jwt/fastify-jwt-tests.ts b/types/fastify-jwt/fastify-jwt-tests.ts index 6b92026b04..fc68ac8bcc 100644 --- a/types/fastify-jwt/fastify-jwt-tests.ts +++ b/types/fastify-jwt/fastify-jwt-tests.ts @@ -1,17 +1,16 @@ -import { IncomingMessage, Server, ServerResponse } from "http"; -import fastifyJwt = require("fastify-jwt"); import fastify = require("fastify"); +import fastifyJwt = require("fastify-jwt"); const app = fastify(); app.register(fastifyJwt, { - secret: "super-secret" + secret: "super-secret", }); app.register(fastifyJwt, { secret: (request, reply, callback) => { return ""; - } + }, }); app.get("/path", (request, reply) => { diff --git a/types/fastify-jwt/package.json b/types/fastify-jwt/package.json index e8c68ab969..5eb77c39fa 100644 --- a/types/fastify-jwt/package.json +++ b/types/fastify-jwt/package.json @@ -1,6 +1,6 @@ { "private": true, "dependencies": { - "fastify": "^1.11.2" + "fastify": ">=1.13.1 || 2.0.0-rc.1" } } From 8ac2b26cf846b8ad38e2ade7a51b03cb3e963dc3 Mon Sep 17 00:00:00 2001 From: Ilari Aarnio Date: Sun, 2 Dec 2018 23:09:05 +0200 Subject: [PATCH 732/799] Add missing types for imap-simple 4.2 Add type definitions for functions: - addBox - delBox - getBoxes - append Fix parameter name for delFlags. --- types/imap-simple/index.d.ts | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/types/imap-simple/index.d.ts b/types/imap-simple/index.d.ts index 3bde57c113..a45629f234 100644 --- a/types/imap-simple/index.d.ts +++ b/types/imap-simple/index.d.ts @@ -1,6 +1,7 @@ -// Type definitions for imap-simple v3.1.0 +// Type definitions for imap-simple v4.2.0 // Project: https://github.com/chadxz/imap-simple // Definitions by: Jeffery Grajkowski +// Ilari Aarnio // Definitions: https://github.com/psnider/DefinitelyTyped/imap-simple /// @@ -42,6 +43,18 @@ export class ImapSimple extends NodeJS.EventEmitter { openBox(boxName: string, callback: (err: Error, boxName: string) => void): void; openBox(boxName: string): Promise; + /** Create a mailbox, calling the provided callback with signature (err, boxName), or resolves the returned promise with boxName. */ + addBox(boxName: string, callback: (err: Error, boxName: string) => void): void; + addBox(boxName: string): Promise; + + /** Delete a mailbox, calling the provided callback with signature (err, boxName), or resolves the returned promise with boxName. */ + delBox(boxName: string, callback: (err: Error, boxName: string) => void): void; + delBox(boxName: string): Promise; + + /** Returns the full list of mailboxes (folders). Upon success, either the provided callback will be called with signature (err, boxes), or the returned promise will be resolved with boxes. Boxes is the exact object returned from the node-imap getBoxes() result. */ + getBoxes(callback: (err: Error, boxes: any) => void): void; + getBoxes(): Promise; + /** Search for and retrieve mail in the previously opened mailbox. */ search(searchCriteria: any[], fetchOptions: Imap.FetchOptions, callback: (err: Error, messages: Message[]) => void): void; search(searchCriteria: any[], fetchOptions: Imap.FetchOptions): Promise; @@ -57,6 +70,10 @@ export class ImapSimple extends NodeJS.EventEmitter { addMessageLabel(source: string | string[], label: string | string[], callback: (err: Error) => void): void; addMessageLabel(source: string | string[], label: string | string[]): Promise; + /** Appends the argument message to the currently open mailbox or another mailbox. Message is a RFC-822 compatible MIME message. Valid options are mailbox, flags and date. When completed, either calls the provided callback with signature (err), or resolves the returned promise. */ + append(message: any, options: any, callback: (err: Error) => void): void; + append(message: any, options: any): Promise; + /** Moves the specified message(s) in the currently open mailbox to another mailbox. source corresponds to a node-imap MessageSource which specifies the messages to be moved. When completed, either calls the provided callback with signature (err), or resolves the returned promise. */ moveMessage(source: string | string[], boxName: string, callback: (err: Error) => void): void; moveMessage(source: string | string[], boxName: string): Promise; @@ -66,8 +83,8 @@ export class ImapSimple extends NodeJS.EventEmitter { addFlags(source: string | string[], flag: string | string[]): Promise; /** Removes the provided flag(s) from the specified message(s). uid is the uid of the message you want to remove the flag from or an array of uids. flag is either a string or array of strings indicating the flags to remove. */ - delFlags(source: string | string[], flag: string | string[], callback: (err: Error) => void): void; - delFlags(source: string | string[], flag: string | string[]): Promise; + delFlags(uid: string | string[], flag: string | string[], callback: (err: Error) => void): void; + delFlags(uid: string | string[], flag: string | string[]): Promise; } export namespace errors { From 539239405f26d75d0dab48f5f4cb5131a324452b Mon Sep 17 00:00:00 2001 From: Alan Plum Date: Sun, 2 Dec 2018 22:40:44 +0100 Subject: [PATCH 733/799] Add roman-numerals --- types/roman-numerals/index.d.ts | 7 +++++++ types/roman-numerals/roman-numerals-tests.ts | 5 +++++ types/roman-numerals/tsconfig.json | 16 ++++++++++++++++ types/roman-numerals/tslint.json | 1 + 4 files changed, 29 insertions(+) create mode 100644 types/roman-numerals/index.d.ts create mode 100644 types/roman-numerals/roman-numerals-tests.ts create mode 100644 types/roman-numerals/tsconfig.json create mode 100644 types/roman-numerals/tslint.json diff --git a/types/roman-numerals/index.d.ts b/types/roman-numerals/index.d.ts new file mode 100644 index 0000000000..0ab8e88047 --- /dev/null +++ b/types/roman-numerals/index.d.ts @@ -0,0 +1,7 @@ +// Type definitions for roman-numerals 0.3 +// Project: https://github.com/joshleaves/roman-numerals +// Definitions by: Alan Plum +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export function toRoman(arabic: number): string; +export function toArabic(roman: string): number; diff --git a/types/roman-numerals/roman-numerals-tests.ts b/types/roman-numerals/roman-numerals-tests.ts new file mode 100644 index 0000000000..a99972afae --- /dev/null +++ b/types/roman-numerals/roman-numerals-tests.ts @@ -0,0 +1,5 @@ +import { toArabic, toRoman } from "roman-numerals"; + +const XLII: string = toRoman(42); +const meaningOfLife: number = toArabic(XLII); +toRoman(meaningOfLife); diff --git a/types/roman-numerals/tsconfig.json b/types/roman-numerals/tsconfig.json new file mode 100644 index 0000000000..7edc311353 --- /dev/null +++ b/types/roman-numerals/tsconfig.json @@ -0,0 +1,16 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": ["index.d.ts", "roman-numerals-tests.ts"] +} diff --git a/types/roman-numerals/tslint.json b/types/roman-numerals/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/roman-numerals/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From ccce0edf6d9dd01a3479daf4b98da3dc7d0bd442 Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 00:26:33 +0100 Subject: [PATCH 734/799] Add types for unique-random-array --- types/unique-random-array/index.d.ts | 8 +++++++ types/unique-random-array/tsconfig.json | 23 +++++++++++++++++++ types/unique-random-array/tslint.json | 1 + .../unique-random-array-tests.ts | 6 +++++ 4 files changed, 38 insertions(+) create mode 100644 types/unique-random-array/index.d.ts create mode 100644 types/unique-random-array/tsconfig.json create mode 100644 types/unique-random-array/tslint.json create mode 100644 types/unique-random-array/unique-random-array-tests.ts diff --git a/types/unique-random-array/index.d.ts b/types/unique-random-array/index.d.ts new file mode 100644 index 0000000000..7e4ddacb0f --- /dev/null +++ b/types/unique-random-array/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for unique-random-array 1.0 +// Project: https://github.com/sindresorhus/unique-random-array#readme +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = uniqueRandomArray; + +declare function uniqueRandomArray(input: T[]): () => T; diff --git a/types/unique-random-array/tsconfig.json b/types/unique-random-array/tsconfig.json new file mode 100644 index 0000000000..40257f7e47 --- /dev/null +++ b/types/unique-random-array/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "unique-random-array-tests.ts" + ] +} diff --git a/types/unique-random-array/tslint.json b/types/unique-random-array/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/unique-random-array/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/unique-random-array/unique-random-array-tests.ts b/types/unique-random-array/unique-random-array-tests.ts new file mode 100644 index 0000000000..de4563532c --- /dev/null +++ b/types/unique-random-array/unique-random-array-tests.ts @@ -0,0 +1,6 @@ +import uniqueRandomArray = require('unique-random-array'); + +// $ExpectType () => number +uniqueRandomArray([1, 2, 3, 4]); +// $ExpectType () => string | number +uniqueRandomArray(["1", 2, 3, 4]); From efaad74d08d3ce0d09f50a3c9b387e1e847df7bb Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 00:35:54 +0100 Subject: [PATCH 735/799] Add types for random-int --- types/random-int/index.d.ts | 9 +++++++++ types/random-int/random-int-tests.ts | 6 ++++++ types/random-int/tsconfig.json | 23 +++++++++++++++++++++++ types/random-int/tslint.json | 1 + 4 files changed, 39 insertions(+) create mode 100644 types/random-int/index.d.ts create mode 100644 types/random-int/random-int-tests.ts create mode 100644 types/random-int/tsconfig.json create mode 100644 types/random-int/tslint.json diff --git a/types/random-int/index.d.ts b/types/random-int/index.d.ts new file mode 100644 index 0000000000..6f7f421976 --- /dev/null +++ b/types/random-int/index.d.ts @@ -0,0 +1,9 @@ +// Type definitions for random-int 1.0 +// Project: https://github.com/sindresorhus/random-int +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = randomInt; + +declare function randomInt(max: number): number; +declare function randomInt(min: number, max: number): number; // tslint:disable-line unified-signatures diff --git a/types/random-int/random-int-tests.ts b/types/random-int/random-int-tests.ts new file mode 100644 index 0000000000..68165e9c5d --- /dev/null +++ b/types/random-int/random-int-tests.ts @@ -0,0 +1,6 @@ +import randomInt = require('random-int'); + +// $ExpectType number +randomInt(5); +// $ExpectType number +randomInt(10, 100); diff --git a/types/random-int/tsconfig.json b/types/random-int/tsconfig.json new file mode 100644 index 0000000000..e1a576d337 --- /dev/null +++ b/types/random-int/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-int-tests.ts" + ] +} diff --git a/types/random-int/tslint.json b/types/random-int/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-int/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From a6d95779bae652a238cd584d66e5009e02d54888 Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 00:42:33 +0100 Subject: [PATCH 736/799] Add types for random-float --- types/random-float/index.d.ts | 9 +++++++++ types/random-float/random-float-tests.ts | 6 ++++++ types/random-float/tsconfig.json | 23 +++++++++++++++++++++++ types/random-float/tslint.json | 1 + 4 files changed, 39 insertions(+) create mode 100644 types/random-float/index.d.ts create mode 100644 types/random-float/random-float-tests.ts create mode 100644 types/random-float/tsconfig.json create mode 100644 types/random-float/tslint.json diff --git a/types/random-float/index.d.ts b/types/random-float/index.d.ts new file mode 100644 index 0000000000..646d263128 --- /dev/null +++ b/types/random-float/index.d.ts @@ -0,0 +1,9 @@ +// Type definitions for random-float 1.0 +// Project: https://github.com/sindresorhus/random-float +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = randomFloat; + +declare function randomFloat(max: number): number; +declare function randomFloat(min: number, max: number): number; // tslint:disable-line unified-signatures diff --git a/types/random-float/random-float-tests.ts b/types/random-float/random-float-tests.ts new file mode 100644 index 0000000000..663190ce81 --- /dev/null +++ b/types/random-float/random-float-tests.ts @@ -0,0 +1,6 @@ +import randomFloat = require('random-float'); + +// $ExpectType number +randomFloat(5); +// $ExpectType number +randomFloat(10, 100); diff --git a/types/random-float/tsconfig.json b/types/random-float/tsconfig.json new file mode 100644 index 0000000000..faefa13645 --- /dev/null +++ b/types/random-float/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-float-tests.ts" + ] +} diff --git a/types/random-float/tslint.json b/types/random-float/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-float/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From cfc0da48c03bde6f87e9d06aa11e1cb3aa6f98ab Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 00:46:11 +0100 Subject: [PATCH 737/799] Add types for random-boolean --- types/random-boolean/index.d.ts | 8 +++++++ types/random-boolean/random-boolean-tests.ts | 4 ++++ types/random-boolean/tsconfig.json | 23 ++++++++++++++++++++ types/random-boolean/tslint.json | 1 + 4 files changed, 36 insertions(+) create mode 100644 types/random-boolean/index.d.ts create mode 100644 types/random-boolean/random-boolean-tests.ts create mode 100644 types/random-boolean/tsconfig.json create mode 100644 types/random-boolean/tslint.json diff --git a/types/random-boolean/index.d.ts b/types/random-boolean/index.d.ts new file mode 100644 index 0000000000..3390da9317 --- /dev/null +++ b/types/random-boolean/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for random-boolean 1.0 +// Project: https://github.com/arthurvr/random-boolean#readme +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = randomBoolean; + +declare function randomBoolean(): boolean; diff --git a/types/random-boolean/random-boolean-tests.ts b/types/random-boolean/random-boolean-tests.ts new file mode 100644 index 0000000000..8ac983e111 --- /dev/null +++ b/types/random-boolean/random-boolean-tests.ts @@ -0,0 +1,4 @@ +import randomBoolean = require('random-boolean'); + +// $ExpectType boolean +randomBoolean(); diff --git a/types/random-boolean/tsconfig.json b/types/random-boolean/tsconfig.json new file mode 100644 index 0000000000..7392190732 --- /dev/null +++ b/types/random-boolean/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-boolean-tests.ts" + ] +} diff --git a/types/random-boolean/tslint.json b/types/random-boolean/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-boolean/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From a7f31adfd5f8480e9c42ba7aa07cedfbcd346beb Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 01:07:20 +0100 Subject: [PATCH 738/799] Add types for random-obj-key --- types/random-obj-key/index.d.ts | 9 ++++++++ types/random-obj-key/random-obj-key-tests.ts | 4 ++++ types/random-obj-key/tsconfig.json | 23 ++++++++++++++++++++ types/random-obj-key/tslint.json | 1 + 4 files changed, 37 insertions(+) create mode 100644 types/random-obj-key/index.d.ts create mode 100644 types/random-obj-key/random-obj-key-tests.ts create mode 100644 types/random-obj-key/tsconfig.json create mode 100644 types/random-obj-key/tslint.json diff --git a/types/random-obj-key/index.d.ts b/types/random-obj-key/index.d.ts new file mode 100644 index 0000000000..dfe12ca6f6 --- /dev/null +++ b/types/random-obj-key/index.d.ts @@ -0,0 +1,9 @@ +// Type definitions for random-obj-key 1.0 +// Project: https://github.com/sindresorhus/random-obj-key +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 + +export = randomObjKey; + +declare function randomObjKey(input: TObj): keyof TObj; diff --git a/types/random-obj-key/random-obj-key-tests.ts b/types/random-obj-key/random-obj-key-tests.ts new file mode 100644 index 0000000000..b12cf282ea --- /dev/null +++ b/types/random-obj-key/random-obj-key-tests.ts @@ -0,0 +1,4 @@ +import randomObjKey = require('random-obj-key'); + +// $ExpectType "foo" | "bar" +randomObjKey({ foo: true, bar: true }); diff --git a/types/random-obj-key/tsconfig.json b/types/random-obj-key/tsconfig.json new file mode 100644 index 0000000000..aaaf33ba98 --- /dev/null +++ b/types/random-obj-key/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-obj-key-tests.ts" + ] +} diff --git a/types/random-obj-key/tslint.json b/types/random-obj-key/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-obj-key/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From a3f716d8f28c05469b8409d0c32a7146ec9a57f3 Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 01:13:39 +0100 Subject: [PATCH 739/799] Add types for random-item --- types/random-item/index.d.ts | 8 ++++++++ types/random-item/random-item-tests.ts | 6 ++++++ types/random-item/tsconfig.json | 23 +++++++++++++++++++++++ types/random-item/tslint.json | 1 + 4 files changed, 38 insertions(+) create mode 100644 types/random-item/index.d.ts create mode 100644 types/random-item/random-item-tests.ts create mode 100644 types/random-item/tsconfig.json create mode 100644 types/random-item/tslint.json diff --git a/types/random-item/index.d.ts b/types/random-item/index.d.ts new file mode 100644 index 0000000000..3fbbaca074 --- /dev/null +++ b/types/random-item/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for random-item 1.0 +// Project: https://github.com/sindresorhus/random-item +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = randomItem; + +declare function randomItem(input: T[]): T; diff --git a/types/random-item/random-item-tests.ts b/types/random-item/random-item-tests.ts new file mode 100644 index 0000000000..12185a0ad2 --- /dev/null +++ b/types/random-item/random-item-tests.ts @@ -0,0 +1,6 @@ +import randomItem = require('random-item'); + +// $ExpectType string +randomItem(['pony', 'unicorn', 'rainbow']); +// $ExpectType string | number +randomItem(['pony', 'unicorn', 'rainbow', 1]); diff --git a/types/random-item/tsconfig.json b/types/random-item/tsconfig.json new file mode 100644 index 0000000000..279aba16b5 --- /dev/null +++ b/types/random-item/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-item-tests.ts" + ] +} diff --git a/types/random-item/tslint.json b/types/random-item/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-item/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From f47939d42dcfe49da2bb73ad1662159bb50ad0e2 Mon Sep 17 00:00:00 2001 From: Dimitri Benin Date: Mon, 3 Dec 2018 01:22:11 +0100 Subject: [PATCH 740/799] Add types for random-obj-prop --- types/random-obj-prop/index.d.ts | 8 +++++++ .../random-obj-prop/random-obj-prop-tests.ts | 4 ++++ types/random-obj-prop/tsconfig.json | 23 +++++++++++++++++++ types/random-obj-prop/tslint.json | 1 + 4 files changed, 36 insertions(+) create mode 100644 types/random-obj-prop/index.d.ts create mode 100644 types/random-obj-prop/random-obj-prop-tests.ts create mode 100644 types/random-obj-prop/tsconfig.json create mode 100644 types/random-obj-prop/tslint.json diff --git a/types/random-obj-prop/index.d.ts b/types/random-obj-prop/index.d.ts new file mode 100644 index 0000000000..f9aca5624f --- /dev/null +++ b/types/random-obj-prop/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for random-obj-prop 1.0 +// Project: https://github.com/sindresorhus/random-obj-prop +// Definitions by: BendingBender +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export = randomObjProp; + +declare function randomObjProp(input: { [key: string]: T }): T; diff --git a/types/random-obj-prop/random-obj-prop-tests.ts b/types/random-obj-prop/random-obj-prop-tests.ts new file mode 100644 index 0000000000..7dd2fcd67d --- /dev/null +++ b/types/random-obj-prop/random-obj-prop-tests.ts @@ -0,0 +1,4 @@ +import randomObjProp = require('random-obj-prop'); + +// $ExpectType string | number +randomObjProp({ foo: 'pony', bar: 1 }); diff --git a/types/random-obj-prop/tsconfig.json b/types/random-obj-prop/tsconfig.json new file mode 100644 index 0000000000..f155cfc211 --- /dev/null +++ b/types/random-obj-prop/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "random-obj-prop-tests.ts" + ] +} diff --git a/types/random-obj-prop/tslint.json b/types/random-obj-prop/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/random-obj-prop/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 9299a86a8b8fafe190f26f00726eee07d2e4e2a1 Mon Sep 17 00:00:00 2001 From: Yaroslav Admin Date: Tue, 27 Nov 2018 21:08:52 +0100 Subject: [PATCH 741/799] Improved structure of the karma type definitions --- types/karma/index.d.ts | 77 +++++++++++++++++++------------------- types/karma/karma-tests.ts | 22 +++++------ 2 files changed, 49 insertions(+), 50 deletions(-) diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index ba258f0997..09b263e104 100644 --- a/types/karma/index.d.ts +++ b/types/karma/index.d.ts @@ -14,24 +14,24 @@ import https = require('https'); import { Appender } from 'log4js'; declare namespace karma { - interface Karma { - /** - * `start` method is deprecated since 0.13. It will be removed in 0.14. - * Please use - * - * server = new Server(config, [done]) - * server.start() - * - * instead. - */ - server: DeprecatedServer; - Server: Server; - runner: Runner; - stopper: Stopper; - launcher: Launcher; - VERSION: string; - constants: Constants; - } + /** + * `start` method is deprecated since 0.13. It will be removed in 0.14. + * Please use + * + * server = new Server(config, [done]) + * server.start() + * + * instead. + * + * @deprecated + */ + const server: DeprecatedServer; + + const runner: Runner; + const stopper: Stopper; + + const VERSION: string; + const constants: Constants; interface Constants { VERSION: string; @@ -57,24 +57,25 @@ declare namespace karma { EXIT_CODE: string; } - interface LauncherStatic { - generateId(): string; - // TODO: injector should be of type `di.Injector` - new (emitter: NodeJS.EventEmitter, injector: any): Launcher; - } + namespace launcher { + class Launcher { + static generateId(): string; - interface Launcher { - Launcher: LauncherStatic; - // TODO: Can this return value ever be typified? - launch(names: string[], protocol: string, hostname: string, port: number, urlRoot: string): any[]; - kill(id: string, callback: () => void): boolean; - restart(id: string): boolean; - killAll(callback: () => void): void; - areAllCaptured(): boolean; - markCaptured(id: string): void; + constructor(emitter: NodeJS.EventEmitter, injector: any); + + // TODO: Can this return value ever be typified? + launch(names: string[], protocol: string, hostname: string, port: number, urlRoot: string): any[]; + kill(id: string, callback: () => void): boolean; + restart(id: string): boolean; + killAll(callback: () => void): void; + areAllCaptured(): boolean; + markCaptured(id: string): void; + } } + /** @deprecated */ interface DeprecatedServer { + /** @deprecated */ start(options?: any, callback?: ServerCallback): void; } @@ -97,10 +98,8 @@ declare namespace karma { success: number; } - interface Server extends NodeJS.EventEmitter { - // TODO: Figure out how to convert Server to class and remove suppression - // tslint:disable-next-line:no-misused-new - new (options?: ConfigOptions | ConfigFile, callback?: ServerCallback): Server; + class Server extends NodeJS.EventEmitter { + constructor(options?: ConfigOptions | ConfigFile, callback?: ServerCallback); /** * Start the server */ @@ -468,8 +467,10 @@ declare namespace karma { flags?: string[]; platform?: string; } + + namespace config { + function parseConfig(configFilePath: string, cliOptions: ConfigOptions): Config; + } } -declare var karma: karma.Karma; - export = karma; diff --git a/types/karma/karma-tests.ts b/types/karma/karma-tests.ts index 4114a77b02..4065a4deff 100644 --- a/types/karma/karma-tests.ts +++ b/types/karma/karma-tests.ts @@ -1,16 +1,6 @@ -import gulp = require('gulp'); import karma = require('karma'); -function runKarma(singleRun: boolean): void { - // MEMO: `start` method is deprecated since 0.13. It will be removed in 0.14. - karma.server.start({ - configFile: __dirname + '/karma.conf.js', - singleRun - }); -} - -gulp.task('test:unit:karma', gulp.parallel('build:test:unit', () => runKarma(true))); - +// karma.server is deprecated and will eventually be removed karma.server.start({port: 9876}, (exitCode: number) => { console.log('Karma has exited with ' + exitCode); process.exit(exitCode); @@ -54,7 +44,8 @@ karma.runner.run({port: 9876}, (exitCode: number) => { process.exit(exitCode); }); -const captured: boolean = karma.launcher.areAllCaptured(); +const launcher: karma.launcher.Launcher = null; +const captured: boolean = launcher.areAllCaptured(); // Example of configuration file karma.conf.ts, see http://karma-runner.github.io/latest/config/configuration-file.html module.exports = (config: karma.Config) => { @@ -123,3 +114,10 @@ const foo = (config: karma.Config) => { } }); }; + +console.log(karma.constants.DEFAULT_HOSTNAME); +console.log(karma.VERSION); + +karma.config.parseConfig('karma.conf.js', { + singleRun: true +}); From 80c2f3dd1202e234af247afb0b7f9e5eaaa2789d Mon Sep 17 00:00:00 2001 From: Yaroslav Admin Date: Tue, 27 Nov 2018 21:29:37 +0100 Subject: [PATCH 742/799] Eliminated obsolete namespace wrapper See https://github.com/Microsoft/dtslint/blob/master/docs/export-just-namespace.md --- types/karma/index.d.ts | 896 ++++++++++++++++++++--------------------- 1 file changed, 446 insertions(+), 450 deletions(-) diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index 09b263e104..0da2803283 100644 --- a/types/karma/index.d.ts +++ b/types/karma/index.d.ts @@ -13,464 +13,460 @@ import Promise = require('bluebird'); import https = require('https'); import { Appender } from 'log4js'; -declare namespace karma { - /** - * `start` method is deprecated since 0.13. It will be removed in 0.14. - * Please use - * - * server = new Server(config, [done]) - * server.start() - * - * instead. - * - * @deprecated - */ - const server: DeprecatedServer; +/** + * `start` method is deprecated since 0.13. It will be removed in 0.14. + * Please use + * + * server = new Server(config, [done]) + * server.start() + * + * instead. + * + * @deprecated + */ +export const server: DeprecatedServer; - const runner: Runner; - const stopper: Stopper; +export const runner: Runner; +export const stopper: Stopper; - const VERSION: string; - const constants: Constants; +export const VERSION: string; +export const constants: Constants; - interface Constants { - VERSION: string; - DEFAULT_PORT: number; - DEFAULT_HOSTNAME: string; - DEFAULT_LISTEN_ADDR: string; - LOG_DISABLE: string; - LOG_ERROR: string; - LOG_WARN: string; - LOG_INFO: string; - LOG_DEBUG: string; - LOG_LOG: string; - LOG_PRIORITIES: string[]; - COLOR_PATTERN: string; - NO_COLOR_PATTERN: string; - CONSOLE_APPENDER: { +export interface Constants { + VERSION: string; + DEFAULT_PORT: number; + DEFAULT_HOSTNAME: string; + DEFAULT_LISTEN_ADDR: string; + LOG_DISABLE: string; + LOG_ERROR: string; + LOG_WARN: string; + LOG_INFO: string; + LOG_DEBUG: string; + LOG_LOG: string; + LOG_PRIORITIES: string[]; + COLOR_PATTERN: string; + NO_COLOR_PATTERN: string; + CONSOLE_APPENDER: { + type: string; + layout: { type: string; - layout: { - type: string; - pattern: string; - }; + pattern: string; }; - EXIT_CODE: string; - } + }; + EXIT_CODE: string; +} - namespace launcher { - class Launcher { - static generateId(): string; +export namespace launcher { + class Launcher { + static generateId(): string; - constructor(emitter: NodeJS.EventEmitter, injector: any); + constructor(emitter: NodeJS.EventEmitter, injector: any); - // TODO: Can this return value ever be typified? - launch(names: string[], protocol: string, hostname: string, port: number, urlRoot: string): any[]; - kill(id: string, callback: () => void): boolean; - restart(id: string): boolean; - killAll(callback: () => void): void; - areAllCaptured(): boolean; - markCaptured(id: string): void; - } - } - - /** @deprecated */ - interface DeprecatedServer { - /** @deprecated */ - start(options?: any, callback?: ServerCallback): void; - } - - interface Runner { - run(options?: ConfigOptions | ConfigFile, callback?: ServerCallback): void; - } - - interface Stopper { - /** - * This function will signal a running server to stop. The equivalent of karma stop. - */ - stop(options?: ConfigOptions, callback?: ServerCallback): void; - } - - interface TestResults { - disconnected: boolean; - error: boolean; - exitCode: number; - failed: number; - success: number; - } - - class Server extends NodeJS.EventEmitter { - constructor(options?: ConfigOptions | ConfigFile, callback?: ServerCallback); - /** - * Start the server - */ - start(): void; - /** - * Get properties from the injector - * @param token - */ - get(token: string): any; - /** - * Force a refresh of the file list - */ - refreshFiles(): Promise; - - on(event: string, listener: (...args: any[]) => void): this; - - /** - * Listen to the 'run_complete' event. - */ - on(event: 'run_complete', listener: (browsers: any, results: TestResults) => void): this; - - /** - * Backward-compatibility with karma-intellij bundled with WebStorm. - * Deprecated since version 0.13, to be removed in 0.14 - */ - // static start(): void; - } - - type ServerCallback = (exitCode: number) => void; - - interface Config { - set: (config: ConfigOptions) => void; - LOG_DISABLE: string; - LOG_ERROR: string; - LOG_WARN: string; - LOG_INFO: string; - LOG_DEBUG: string; - } - - interface ConfigFile { - configFile: string; - } - - interface ConfigOptions { - /** - * @description Enable or disable watching files and executing the tests whenever one of these files changes. - * @default true - */ - autoWatch?: boolean; - /** - * @description When Karma is watching the files for changes, it tries to batch multiple changes into a single run - * so that the test runner doesn't try to start and restart running tests more than it should. - * The configuration setting tells Karma how long to wait (in milliseconds) after any changes have occurred - * before starting the test process again. - * @default 250 - */ - autoWatchBatchDelay?: number; - /** - * @default '' - * @description The root path location that will be used to resolve all relative paths defined in files and exclude. - * If the basePath configuration is a relative path then it will be resolved to - * the __dirname of the configuration file. - */ - basePath?: string; - /** - * @default 2000 - * @description How long does Karma wait for a browser to reconnect (in ms). - *

- * With a flaky connection it is pretty common that the browser disconnects, - * but the actual test execution is still running without any problems. Karma does not treat a disconnection - * as immediate failure and will wait browserDisconnectTimeout (ms). - * If the browser reconnects during that time, everything is fine. - *

- */ - browserDisconnectTimeout?: number; - /** - * @default 0 - * @description The number of disconnections tolerated. - *

- * The disconnectTolerance value represents the maximum number of tries a browser will attempt - * in the case of a disconnection. Usually any disconnection is considered a failure, - * but this option allows you to define a tolerance level when there is a flaky network link between - * the Karma server and the browsers. - *

- */ - browserDisconnectTolerance?: number; - /** - * @default 10000 - * @description How long will Karma wait for a message from a browser before disconnecting from it (in ms). - *

- * If, during test execution, Karma does not receive any message from a browser within - * browserNoActivityTimeout (ms), it will disconnect from the browser - *

- */ - browserNoActivityTimeout?: number; - /** - * @default [] - * Possible Values: - *
    - *
  • Chrome (launcher comes installed with Karma)
    • - *
  • ChromeCanary (launcher comes installed with Karma)
    • - *
  • PhantomJS (launcher comes installed with Karma)
    • - *
  • Firefox (launcher requires karma-firefox-launcher plugin)
    • - *
  • Opera (launcher requires karma-opera-launcher plugin)
    • - *
  • Internet Explorer (launcher requires karma-ie-launcher plugin)
    • - *
  • Safari (launcher requires karma-safari-launcher plugin)
    • - *
- * @description A list of browsers to launch and capture. When Karma starts up, it will also start up each browser - * which is placed within this setting. Once Karma is shut down, it will shut down these browsers as well. - * You can capture any browser manually by opening the browser and visiting the URL where - * the Karma web server is listening (by default it is http://localhost:9876/). - */ - browsers?: string[]; - /** - * @default 60000 - * @description Timeout for capturing a browser (in ms). - *

- * The captureTimeout value represents the maximum boot-up time allowed for a - * browser to start and connect to Karma. If any browser does not get captured within the timeout, Karma - * will kill it and try to launch it again and, after three attempts to capture it, Karma will give up. - *

- */ - captureTimeout?: number; - client?: ClientOptions; - /** - * @default true - * @description Enable or disable colors in the output (reporters and logs). - */ - colors?: boolean; - /** - * @default 'Infinity' - * @description How many browsers Karma launches in parallel. - * Especially on services like SauceLabs and Browserstack, it makes sense only to launch a limited - * amount of browsers at once, and only start more when those have finished. Using this configuration, - * you can specify how many browsers should be running at once at any given point in time. - */ - concurrency?: number; - customLaunchers?: { [key: string]: CustomLauncher }; - /** - * @default [] - * @description List of files/patterns to exclude from loaded files. - */ - exclude?: string[]; - /** - * @default [] - * @description List of files/patterns to load in the browser. - */ - files?: Array; - /** - * @default [] - * @description List of test frameworks you want to use. Typically, you will set this to ['jasmine'], ['mocha'] or ['qunit']... - * Please note just about all frameworks in Karma require an additional plugin/framework library to be installed (via NPM). - */ - frameworks?: string[]; - /** - * @default 'localhost' - * @description Hostname to be used when capturing browsers. - */ - hostname?: string; - /** - * @default {} - * @description Options object to be used by Node's https class. - * Object description can be found in the - * [NodeJS.org API docs](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener) - */ - httpsServerOptions?: https.ServerOptions; - /** - * @default config.LOG_INFO - * Possible values: - *
    - *
  • config.LOG_DISABLE
    • - *
  • config.LOG_ERROR
    • - *
  • config.LOG_WARN
    • - *
  • config.LOG_INFO
    • - *
  • config.LOG_DEBUG
    • - *
- * @description Level of logging. - */ - logLevel?: string; - /** - * @default [{type: 'console'}] - * @description A list of log appenders to be used. See the documentation for [log4js] for more information. - */ - loggers?: { [name: string]: Appender } | Appender[]; - /** - * @default [] - * @description List of names of additional middleware you want the - * Karma server to use. Middleware will be used in the order listed. - * You must have installed the middleware via a plugin/framework - * (either inline or via NPM). Additional information can be found in - * [plugins](http://karma-runner.github.io/2.0/config/plugins.html). - * The plugin must provide an express/connect middleware function - * (details about this can be found in the - * [Express](http://expressjs.com/guide/using-middleware.html) docs). - */ - middleware?: string[]; - /** - * @default {} - * @description Redefine default mapping from file extensions to MIME-type. - * Set property name to required MIME, provide Array of extensions (without dots) as it's value. - */ - mime?: {[type: string]: string[]}; - /** - * @default ['karma-*'] - * @description List of plugins to load. A plugin can be a string (in which case it will be required - * by Karma) or an inlined plugin - Object. - * By default, Karma loads all sibling NPM modules which have a name starting with karma-*. - * Note: Just about all plugins in Karma require an additional library to be installed (via NPM). - */ - plugins?: any[]; - /** - * @default 9876 - * @description The port where the web server will be listening. - */ - port?: number; - /** - * @default {'**\/*.coffee': 'coffee'} - * @description A map of preprocessors to use. - * - * Preprocessors can be loaded through [plugins]. - * - * Note: Just about all preprocessors in Karma (other than CoffeeScript and some other defaults) - * require an additional library to be installed (via NPM). - * - * Be aware that preprocessors may be transforming the files and file types that are available at run time. For instance, - * if you are using the "coverage" preprocessor on your source files, if you then attempt to interactively debug - * your tests, you'll discover that your expected source code is completely changed from what you expected. Because - * of that, you'll want to engineer this so that your automated builds use the coverage entry in the "reporters" list, - * but your interactive debugging does not. - * - */ - preprocessors?: { [name: string]: string | string[] }; - /** - * @default 'http:' - * Possible Values: - *
    - *
  • http:
    • - *
  • https:
    • - *
- * @description Protocol used for running the Karma webserver. - * Determines the use of the Node http or https class. - * Note: Using 'https:' requires you to specify httpsServerOptions. - */ - protocol?: string; - /** - * @default {} - * @description A map of path-proxy pairs. - */ - proxies?: { [path: string]: string }; - /** - * @default true - * @description Whether or not Karma or any browsers should raise an error when an inavlid SSL certificate is found. - */ - proxyValidateSSL?: boolean; - /** - * @default 0 - * @description Karma will report all the tests that are slower than given time limit (in ms). - * This is disabled by default (since the default value is 0). - */ - reportSlowerThan?: number; - /** - * @default ['progress'] - * Possible Values: - *
    - *
  • dots
    • - *
  • progress
    • - *
- * @description A list of reporters to use. - * Additional reporters, such as growl, junit, teamcity or coverage can be loaded through plugins. - * Note: Just about all additional reporters in Karma (other than progress) require an additional library to be installed (via NPM). - */ - reporters?: string[]; - /** - * @default false - * @description Continuous Integration mode. - * If true, Karma will start and capture all configured browsers, run tests and then exit with an exit code of 0 or 1 depending - * on whether all tests passed or any tests failed. - */ - singleRun?: boolean; - /** - * @default ['polling', 'websocket'] - * @description An array of allowed transport methods between the browser and testing server. This configuration setting - * is handed off to [socket.io](http://socket.io/) (which manages the communication - * between browsers and the testing server). - */ - transports?: string[]; - /** - * @default '/' - * @description The base url, where Karma runs. - * All of Karma's urls get prefixed with the urlRoot. This is helpful when using proxies, as - * sometimes you might want to proxy a url that is already taken by Karma. - */ - urlRoot?: string; - } - - interface ClientOptions { - /** - * @default undefined - * @description When karma run is passed additional arguments on the command-line, they - * are passed through to the test adapter as karma.config.args (an array of strings). - * The client.args option allows you to set this value for actions other than run. - * How this value is used is up to your test adapter - you should check your adapter's - * documentation to see how (and if) it uses this value. - */ - args?: string[]; - /** - * @default true - * @description Run the tests inside an iFrame or a new window - * If true, Karma runs the tests inside an iFrame. If false, Karma runs the tests in a new window. Some tests may not run in an - * iFrame and may need a new window to run. - */ - useIframe?: boolean; - /** - * @default true - * @description Capture all console output and pipe it to the terminal. - */ - captureConsole?: boolean; - /** - * @default false - * @description Run the tests on the same window as the client, without using iframe or a new window - */ - runInParent?: boolean; - /** - * @default true - * @description Clear the context window - * If true, Karma clears the context window upon the completion of running the tests. - * If false, Karma does not clear the context window upon the completion of running the tests. - * Setting this to false is useful when embedding a Jasmine Spec Runner Template. - */ - clearContext?: boolean; - } - - interface FilePattern { - /** - * The pattern to use for matching. This property is mandatory. - */ - pattern: string; - /** - * @default true - * @description If autoWatch is true all files that have set watched to true will be watched - * for changes. - */ - watched?: boolean; - /** - * @default true - * @description Should the files be included in the browser using